Public candidate · generated contract documentation

Platform API reference

Selected CRM, ERP and grain workflows and procedure contracts. Coverage is limited to the reviewed paths shown here. This documentation does not grant access. Authentication, authorization and business rules remain enforced by the application. Search by procedure, field or description.

Search procedures

323documented procedures
31namespaces
309 / 323input / output schemas
9contracts with unmodeled nodes
Reading these procedure contracts

Documentation only. This documentation does not grant access. Authentication, authorization and business rules remain enforced by the application. This page provides no executable API, live records or live requests.

Logical JSON wire values. Amount and UnitPrice use decimal strings; Instant and CalendarDay use date-time and date strings. Native RPC envelopes, batching and transport metadata are separate. These schemas describe selected reviewed procedures; they are not an executable HTTP/OpenAPI specification.

Runtime refinements, transformations and coercion remain authoritative in the application. Displayed normalized types can be narrower than accepted coercible inputs. Runtime defaults are not evaluated and their values are omitted. This documentation does not change the underlying contracts or access rules.

9 contracts contain unmodeled nodes. Their exact locations remain marked; informational component or inner shapes do not model the missing composition. A missing output schema means its value is unknown. An absent input schema means no input shape is inferred and may describe an intentional no-user-payload operation.

Machine-readable contract catalog

Workflow guide

UI supported stages have a current UI calling path. Backend only identifies a mounted operation without a confirmed current UI path. Stub identifies a declared placeholder whose persistence or behavior is not established. These labels describe the reviewed evidence.

WorkflowStagesReadiness
Manage customer relationships and opportunities8UI supported
Quote, fulfill, purchase, and invoice35UI supported, Backend only
Run grain, delivery, settlement, and service workflows11UI supported
Manage customer relationships and opportunities 8 stages

Follow customer records from account setup and contact maintenance through notes, imports and deal tracking. The ERP guide covers quote, order, fulfillment and invoicing after a deal starts.

  1. Find or add a customer UI supported

    Search and filter the customer book. Before adding an account, read the available targets and check for an existing customer or company match. A successful create returns an account identifier and summary; use that identifier to open the account or start a deal.

    Prerequisites
    • Use account.createAvailability to see which account target types can be created; company creation may use an existing company match.
    Reads
    Writes
    Outputs
    • On success, account.create returns the account ID and account summary. Refresh the customer list, then use the ID to open the account or start a deal.
    Expected refusals and limitations
    • A duplicate email or phone, unavailable target, or unconnectable company/contact prevents creation.
  2. Link and maintain account contacts UI supported

    Load people associated with the account and check possible matches before attaching someone. Attach an existing person or create a contact from supplied details; revise permitted contact details or detach the relationship. Detaching leaves the person record in the directory.

    Prerequisites
    • Select the account whose people and contact details you want to change.
    Reads
    Writes
    Outputs
    • The account people view reflects the relationship or contact change. Detaching removes the account link and leaves the person directory record.
    Expected refusals and limitations
    • Duplicate email or phone, a contact that cannot be edited in its current state, or a missing relationship prevents the change.
  3. Maintain farm, field, and legal-entity details UI supported

    Read the account and its operation to obtain the farm and field identifiers. Update acreage or farm name, manage field crop/acreage/destination details, and create or revise the optional organization record. Account standing can also be restricted or reinstated.

    Prerequisites
    • Open a farm account and use its operation result for farm and field identifiers; the legal entity can be absent.
    Reads
    Writes
    Outputs
    • The farm, field, organization, and account-standing views reflect successful updates; use each operation response before continuing.
    Expected refusals and limitations
    • A missing farm or field, missing address, or an organization field that is already on file or not editable can block an update.
  4. Share a company catalog UI supported

    Read the company account, its catalog-sharing view, shared items and incoming order summaries. Offer the catalog, change an item’s shared status, or withdraw the catalog relationship through the available controls.

    Prerequisites
    • Open a company account with catalog-sharing options.
    Reads
    Writes
    Outputs
    • The account view reflects catalog sharing and item changes; refresh the sharing view after each action.
    Expected refusals and limitations
    • The relationship cannot be made with the same company; an item may be absent or a blend may not be shared.
  5. Record account notes and follow-ups UI supported

    Read account notes and the book’s due-date options, then add a note or touchpoint with an optional follow-up date and deal context. Re-read the account notes to see the saved interaction.

    Prerequisites
    • Open the account and read book-date options before setting a follow-up date.
    Reads
    Writes
    Outputs
    • note.add returns interactionId and accountId. Reread note.byAccount to see the saved interaction.
    Expected refusals and limitations
    • An unavailable account or a note rejected by the business action cannot be saved.
  6. Review and import customer records UI supported

    Read import progress and the customer book, then preview the source records. Submit only the reviewed selections; if source records changed after preview, review them again. CSV and smart-sheet paths map and validate rows before import. Resetting progress restarts checkpoints without deleting customer records.

    Prerequisites
    • The selected import source must be available. ConnectedFi-backed preview and whole-book sync use that source; CSV import does not. Smart-sheet planning depends on model availability.
    Reads
    Writes
    Outputs
    • Preview results show matched selections and unresolved rows. A completed import returns its action result and progress; an empty selection writes no customer rows.
    Expected refusals and limitations
    • Changed source records require a new review. Invalid rows or an unavailable source/model can prevent an import; an empty selection completes review without writing customer records.
  7. Start a deal and review the pipeline UI supported

    Choose an existing account or create one, then create a deal with its account and title. The returned deal ID opens the quote/order flow. Deal, quote, journey, dashboard and pipeline reads show the current opportunity context.

    Prerequisites
    • Choose an account from the customer search or create one; the account must allow new business.
    Reads
    Writes
    Outputs
    • deal.create returns a deal ID; refreshed deal and pipeline reads show the opportunity context. The ERP guide covers quote and order steps after deal creation.
    Expected refusals and limitations
    • A restricted account or unavailable account relationship prevents deal creation. The Financing pipeline stage is pending and should not be treated as an available workflow.
  8. Import historical order rows UI supported

    Preview uploaded historical rows and resolve account, warehouse, item, amount and date matches. Commit the reviewed batch to create its linked deal, order and money records.

    Prerequisites
    • Upload historical rows and match account, item, and warehouse references before commit.
    Reads
    Writes
    Outputs
    • A successful import returns linked dealId, saleOrderId, chargeId, and paymentId.
    Expected refusals and limitations
    • Unresolved matches or invalid row details can prevent commit; review the importer’s returned blockers before retrying.
Other boundaries and schema limitations
  • The Financing stage shown in pipeline vocabulary is pending; no completed financing-pipeline workflow is described here.
  • note.pin and note.byContext are mounted procedures without a bound current UI call in the reviewed flow, so they are omitted from the guided steps.
  • Whole-book customer Sync is a separate action from the reviewed import wizard paths. A zero unsynced count is not proof that a source book is fully synchronized.
  • The historical-order importer is a separate Settings workflow; it is not a substitute for the ordinary quote, order, invoice, or payment flow.
Quote, fulfill, purchase, and invoice 35 stages

Trace a customer opportunity into a quote or direct order, plan and fulfill it, and issue invoices or record payments. Invoice issuance can happen before fulfillment or payment. Separate workflows cover buying stock, warehouse records, shipping and importing a seller invoice.

  1. Build quote, send, accept into order: Start UI supported

    Deal summary born in request

    Prerequisites
    • An accessible existing or newly created unrestricted customer account
    Reads
    Writes
    Outputs
    • Deal summary born in request
    Expected refusals and limitations
    • forbidden
    • not_a_member
    • account_restricted
  2. Build quote, send, accept into order: Load and price quote UI supported

    {deal,quote} saved version; request -> quote

    Prerequisites
    • Request-stage deal, distinct catalog items, valid sale increments and firm price
    Reads
    Writes
    Outputs
    • {deal,quote} saved version; request -> quote
    Expected refusals and limitations
    • not_request
    • empty_lines
    • duplicate_item
    • off_increment
    • unpriceable_line
    • discount_exceeds_price
    • line_too_large
    • save_failed
  3. Build quote, send, accept into order: Revise / send UI supported

    New quote revision or send receipt. Preview is read-only; send queues notification.

    Prerequisites
    • Current accessible quote; valid recipient/channel for sending; revision uses contract note/line/cut requirements
    Reads
    Writes
    Outputs
    • New quote revision or send receipt. Preview is read-only; send queues notification.
    Expected refusals and limitations

    None specified.

  4. Build quote, send, accept into order: Accept Quote UI supported

    {deal,saleOrderId}; quote -> accept and creates order in same transaction

    Prerequisites
    • Current unexpired quote still awaiting acceptance
    Reads

    None in this stage.

    Writes
    Outputs
    • {deal,saleOrderId}; quote -> accept and creates order in same transaction
    Expected refusals and limitations
    • not_quote
    • no_current_quote
    • quote_expired
    • forbidden
    • not_a_member
  5. Build quote, send, accept into order: End abandoned opportunity UI supported

    Business lifecycle result; consult distinct contracts for valid source state

    Prerequisites

    None specified.

    Reads

    None in this stage.

    Writes
    Outputs
    • Business lifecycle result; consult distinct contracts for valid source state
    Expected refusals and limitations

    None specified.

  6. Direct order from shared builder: Start request UI supported

    request dealId

    Prerequisites

    None specified.

    Reads

    None in this stage.

    Writes
    Outputs
    • request dealId
    Expected refusals and limitations

    None specified.

  7. Direct order from shared builder: Place order UI supported

    {deal,saleOrderId}; request -> quote -> accept atomically; server stamps direct channel

    Prerequisites

    None specified.

    Reads
    Writes
    Outputs
    • {deal,saleOrderId}; request -> quote -> accept atomically; server stamps direct channel
    Expected refusals and limitations
    • not_request
    • empty_lines
    • duplicate_item
    • off_increment
    • unpriceable_line
    • quote_expired
  8. Plan and fulfill order: Review accepted order UI supported

    Order, saved agreed lines, plan/work verdicts

    Prerequisites

    None specified.

    Reads
    Writes

    None in this stage.

    Outputs
    • Order, saved agreed lines, plan/work verdicts
    Expected refusals and limitations

    None specified.

  9. Plan and fulfill order: Confirm full plan UI supported

    {saleOrderId,linesConfirmed}; creates line fulfillment roots

    Prerequisites
    • Open order, no previously confirmed plan, complete exact line set; accessible pickup warehouse or delivery field with address
    Reads

    None in this stage.

    Writes
    Outputs
    • {saleOrderId,linesConfirmed}; creates line fulfillment roots
    Expected refusals and limitations
    • not_open
    • already_confirmed
    • line_set_mismatch
    • unknown_warehouse
    • no_destination
    • supplier_ambiguous
    • supplier_item_mismatch
    • supplier_item_ambiguous
    • supplier_pickup_unsupported
  10. Plan and fulfill order: Change fulfillment UI supported

    Revised LineFulfillment

    Prerequisites
    • Open leaf; supplier-handled endpoint fixed
    Reads

    None in this stage.

    Writes
    Outputs
    • Revised LineFulfillment
    Expected refusals and limitations
    • not_open
    • no_destination
    • unknown_warehouse
    • supplier_endpoint_fixed
  11. Plan and fulfill order: Record pickup or shipment UI supported

    {lineFulfillmentId,remainderLineFulfillmentId nullable,consumptionIds[],shipmentId nullable}

    Prerequisites
    • Open line and order, compatible source warehouse, sufficient stock, valid movement increment/amount; no financed return in flight
    Reads
    Writes
    Outputs
    • {lineFulfillmentId,remainderLineFulfillmentId nullable,consumptionIds[],shipmentId nullable}
    Expected refusals and limitations
    • not_open
    • order_not_open
    • line_not_on_order
    • unknown_catalog_item
    • warehouse_unready
    • wrong_pickup_warehouse
    • insufficient_stock
    • return_in_flight
    • not_a_delivery
    • not_outbound
    • delivery_tracking_off
    • off_increment
    • movement_exceeds_open
    • movement_does_not_complete_open
    • children_do_not_conserve_parent
  12. Plan and fulfill order: Cancel open fulfillment UI supported

    Cancel an open fulfillment line when the business state permits; refresh the queue to see its updated state.

    Prerequisites

    None specified.

    Reads

    None in this stage.

    Writes
    Outputs
    • Cancel an open fulfillment line when the business state permits; refresh the queue to see its updated state.
    Expected refusals and limitations

    None specified.

  13. Issue invoice and collect payment: Choose billable lines UI supported

    Server-composed order money board with lines, invoices, collections, current state and work permissions

    Prerequisites

    None specified.

    Reads
    Writes

    None in this stage.

    Outputs
    • Server-composed order money board with lines, invoices, collections, current state and work permissions
    Expected refusals and limitations

    None specified.

  14. Issue invoice and collect payment: Issue document without payment UI supported

    Issue an invoice for selected remaining order lines on an open order. Invoice issuance does not require fulfillment or payment.

    Prerequisites
    • Open order; selected lines have positive remaining quantity and a firm accepted quote price; no selected line is already billed or reserved.
    Reads

    None in this stage.

    Writes
    Outputs
    • {chargeId,invoiceKey}
    Expected refusals and limitations
    • order_not_open
    • not_invoicable
    • already_invoiced
    • already_selected
    • not_firm_total
    • forbidden
  15. Issue invoice and collect payment: Choose hand/CFi payment source UI supported

    Per-loan offer: drawable, blocked or checking, available amount, reason, tranches and preselection

    Prerequisites
    • Existing configured grower account loan for CFi; partner session and verified account contact; unavailable checks yield blocked/checking rather than a fabricated offer
    Reads
    Writes

    None in this stage.

    Outputs
    • Per-loan offer: drawable, blocked or checking, available amount, reason, tranches and preselection
    Expected refusals and limitations

    None specified.

  16. Issue invoice and collect payment: Collect selected unbilled lines UI supported

    The action returns a collection result envelope; that does not mean every payment is settled. Read the order money board for actual payment outcomes, and check it before retrying an unresolved provider result.

    Prerequisites
    • Eligible billable selected lines and exact payment coverage.
    Reads

    None in this stage.

    Writes
    Outputs
    • {collectionId}; follow board for payment and invoice outcome
    Expected refusals and limitations
    • coverage_mismatch
    • result_unresolved
    • not_ready
    • already_selected
    • already_paid
    • no_financing
    • amount_exceeds_open
    • payments_not_received
  17. Issue invoice and collect payment: Resolve collection UI supported

    Resume unresolved collection work or replace definitively declined allocations while preserving confirmed receipts. Read the order money board afterward; an outer success result does not establish that every provider payment settled.

    Prerequisites
    • Use the same collection ID and the board’s current unresolved or declined payment rows.
    Reads

    None in this stage.

    Writes
    Outputs
    • Same collectionId; preserve confirmed receipts, resume unresolved identities, replace definitive declined allocations
    Expected refusals and limitations
    • not_retryable
    • not_removable
    • result_unresolved
    • not_found
    • coverage_mismatch
  18. Issue invoice and collect payment: Pay already issued invoice UI supported

    Record payment against an issued invoice. Refresh the order money board to verify the resulting state before retrying if the provider result is unresolved.

    Prerequisites
    • Positive amount within the remaining allocatable balance. For CFi, use a loan and tranche offered for this same account and invoice.
    Reads

    None in this stage.

    Writes
    Outputs
    • {paymentId,dealClose?}; refresh board to see row state
    Expected refusals and limitations
    • amount_exceeds_open
    • already_settled
    • duplicate
    • no_relationship
    • not_retryable
    • not_cfi
    • row_not_found
    • not_removable
    • already_terminal
    • no_financing
  19. Issue invoice and collect payment: Send invoice UI supported

    Notification send receipt

    Prerequisites
    • Issued accessible invoice with valid account contact/channel
    Reads
    Writes
    Outputs
    • Notification send receipt
    Expected refusals and limitations

    None specified.

  20. Issue invoice and collect payment: Cancel item paid by financed draw UI supported

    Return consequence and open delivery cancellation per contract

    Prerequisites
    • Existing account/loan and returnable paid line; use read-provided tranche/payment context
    Reads
    Writes
    Outputs
    • Return consequence and open delivery cancellation per contract
    Expected refusals and limitations

    None specified.

  21. Record purchase, receive stock, add actual price: Open contextual purchase UI supported

    Accessible suppliers/warehouses, starting lines, receipt quantities, applicable catalog and send preview

    Prerequisites

    None specified.

    Reads
    Writes

    None in this stage.

    Outputs
    • Accessible suppliers/warehouses, starting lines, receipt quantities, applicable catalog and send preview
    Expected refusals and limitations

    None specified.

  22. Record purchase, receive stock, add actual price: Record expected or received purchase UI supported

    {preview:false,purchaseOrderId,reference,summary,lines,status,notificationId?}

    Prerequisites
    • One dealership; compatible supplier and warehouse; distinct bought catalog items; positive exact quantity. Received date today or earlier.
    Reads

    None in this stage.

    Writes
    Outputs
    • {preview:false,purchaseOrderId,reference,summary,lines,status,notificationId?}
    Expected refusals and limitations
    • future_receipt
    • incompatible_item
    • invalid_quantity
    • duplicate_item
    • not_bought
    • catalog_item_not_found
    • po_cancelled
    • po_received
    • no_contact_email
    • recipient_not_on_account
  23. Record purchase, receive stock, add actual price: Receive outstanding goods UI supported

    Receive outstanding purchase-order quantities, creating the receipt and stock lots once. Use stockEntry.receive for whole-purchase-order receiving.

    Prerequisites
    • Open accessible PO and warehouse; receipt quantity <= outstanding; nonfuture receipt date
    Reads

    None in this stage.

    Writes
    Outputs
    • StockEntryResult; receipt and lots saved once; optional remainder forgiveness
    Expected refusals and limitations
    • po_missing
    • invalid_quantity
    • incompatible_item
    • duplicate_item
    • future_receipt
  24. Record purchase, receive stock, add actual price: Enter first actual cost later UI supported

    StockEntryResult, with preview:false; saves receipt price without receiving stock again

    Prerequisites
    • Received item missing actual price
    Reads

    None in this stage.

    Writes
    Outputs
    • StockEntryResult, with preview:false; saves receipt price without receiving stock again
    Expected refusals and limitations
    • nothing_to_price
    • price_recorded
    • duplicate_item
    • po_missing
  25. Record purchase, receive stock, add actual price: PO detail and document UI supported

    PO/line rollups, send preview, {filename,base64} PDF; normal costs/prices are public business schema

    Prerequisites

    None specified.

    Reads
    Writes

    None in this stage.

    Outputs
    • PO/line rollups, send preview, {filename,base64} PDF; normal costs/prices are public business schema
    Expected refusals and limitations

    None specified.

  26. Record purchase, receive stock, add actual price: Close remainder / cancel / resend / attach UI supported

    closeShort {forgivenLines,qtyForgiven decimal}; cancel {purchaseOrderId}; other action receipts

    Prerequisites
    • Close short: open PO with outstanding quantity; cancel: open PO with no receipts; send: valid current contact recipients
    Reads

    None in this stage.

    Writes
    Outputs
    • closeShort {forgivenLines,qtyForgiven decimal}; cancel {purchaseOrderId}; other action receipts
    Expected refusals and limitations
    • not_open
    • nothing_outstanding
    • has_receipts
    • po_cancelled
    • po_received
    • no_contact_email
    • recipient_not_on_account
  27. Warehouse stock and outbound shipping: Inspect demand, inventory and inbound UI supported

    Business stock/demand/lots/inbound read models

    Prerequisites

    None specified.

    Reads
    Writes

    None in this stage.

    Outputs
    • Business stock/demand/lots/inbound read models
    Expected refusals and limitations

    None specified.

  28. Warehouse stock and outbound shipping: Backend stock summaries Backend only

    These business read procedures return supply-coverage and blend-demand summaries. They are documented backend endpoints with no matching current UI call in the reviewed workflow.

    Prerequisites
    • Use their declared query fields and refresh the relevant source records before interpreting a summary.
    Reads
    Writes

    None in this stage.

    Outputs
    • Supply-board rows or blend-demand cards, rows, and totals.
    Expected refusals and limitations

    None specified.

  29. Warehouse stock and outbound shipping: Record opening stock UI supported

    {layerIds[]}

    Prerequisites
    • Accessible stocked item and warehouse
    Reads

    None in this stage.

    Writes
    Outputs
    • {layerIds[]}
    Expected refusals and limitations
    • no_company
    • unknown_sku
    • warehouse_not_found
    • forbidden
  30. Warehouse stock and outbound shipping: Record manufactured stock UI supported

    {layerId}

    Prerequisites
    • Item marked manufactured by current company
    Reads

    None in this stage.

    Writes
    Outputs
    • {layerId}
    Expected refusals and limitations
    • no_company
    • catalog_item_not_found
    • warehouse_not_found
    • not_manufactured
  31. Warehouse stock and outbound shipping: Warehouse management UI supported

    Add a warehouse or revise an existing warehouse record using its submitted name, address, and pickup details.

    Prerequisites

    None specified.

    Reads

    None in this stage.

    Writes
    Outputs
    • Add a warehouse or revise an existing warehouse record using its submitted name, address, and pickup details.
    Expected refusals and limitations

    None specified.

  32. Warehouse stock and outbound shipping: Track shipping UI supported

    {shipmentId}; in-transit outbound delivery -> delivered

    Prerequisites
    • Outbound in-transit shipment and delivery tracking enabled
    Reads
    Writes
    Outputs
    • {shipmentId}; in-transit outbound delivery -> delivered
    Expected refusals and limitations
    • not_found
    • not_in_transit
    • not_outbound
    • delivery_tracking_off
    • forbidden
    • not_a_member
  33. Import seller invoice into sales spine: Parse and review uploaded document UI supported

    Read the uploaded seller invoice through parsing, matching, and preview procedures to resolve line, price, warehouse, date, and invoice-number questions.

    Prerequisites
    • Stored invoice upload ref; existing account/catalog items; review resolves assignment, price differences, warehouse/date/number
    Reads
    Writes

    None in this stage.

    Outputs
    • Read the uploaded seller invoice through parsing, matching, and preview procedures to resolve line, price, warehouse, date, and invoice-number questions.
    Expected refusals and limitations

    None specified.

  34. Import seller invoice into sales spine: Confirm import UI supported

    Commit the reviewed seller invoice into linked deal, sales-order, fulfillment and charge records. Existing catalog items are required.

    Prerequisites
    • Existing catalog only; no product creation; balanced parsed invoice and unchanged reviewed price facts
    Reads

    None in this stage.

    Writes
    Outputs
    • {dealId,saleOrderId,fulfillmentIds[],chargeIds[]}
    Expected refusals and limitations
    • foreign_ref
    • unparseable
    • unresolved_lines
    • price_moved
    • price_settled
    • price_question_gone
    • invoice_key_taken
    • invoiced_in_future
    • unbalanced_document
    • off_increment
    • unit_mismatch
    • item_at_two_prices
    • unknown_warehouse
    • not_invoicable
    • not_firm_total
    • price_not_agreed
  35. Issue invoice and collect payment: Additional invoice-composer endpoints Backend only

    The invoice-composer board read and payment retry/removal actions are real business endpoints. They are documented as backend-only because no current direct UI call was found; they are not required steps in the visible payment flow.

    Prerequisites
    • Use current charge and payment identifiers from the invoice ledger.
    Reads
    Writes
    Outputs
    • The board returns the charge ledger and payment rows; retry/removal returns an action result.
    Expected refusals and limitations

    None specified.

Other boundaries and schema limitations
  • invoiceComposer.board, invoiceComposer.retryPayment, and invoiceComposer.removePayment are mounted real business procedures, but the reviewed current UI calls only invoiceComposer.chargeInvoice; treat the other three as backend-only.
  • Whole-purchase-order receiving uses stockEntry.receive; do not assume a receipt from purchase-order status labels alone.
  • File upload transport and stored document references for seller-invoice import are not fully described by the logical JSON schema; the upload itself is a prerequisite and invoice payload internals remain broader than the emitted schema.
  • Historical order import is a separate Settings workflow. It is not part of the seller-invoice import or ordinary sales flow.
Run grain, delivery, settlement, and service workflows 11 stages

Move between contract proposals, offers, delivery scheduling, ticketing, settlement, storage movements and service orders. The grain ticket contract-settlement path and open-delivery disposition path are separate workflows.

  1. Prepare the book, elevator/bin and parties UI supported

    IDs for created business records; scoped pages, capacity, availability/verdicts. Bin removal/elevator retirement are ordinary product lifecycle operations with guarded business commitments.

    Prerequisites
    • Book setup, party/account/payment setup come from CRM/business routes. Read option and verdict answers before writes.
    Reads
    Writes
    Outputs
    • IDs for created business records; scoped pages, capacity, availability/verdicts. Bin removal/elevator retirement are ordinary product lifecycle operations with guarded business commitments.
    Expected refusals and limitations
    • forbidden/not_a_member; no_company; per-operation business guards; out-of-scope row may be not-found or null.
  2. Request, review and agree a proposal UI supported

    Inquiry -> requested; issue/replace proposal -> proposed; counter -> requested; decline/withdraw -> terminal states. Accept exact locked proposal -> accepted plus contractId/envelopeId, contract awaiting signature and e-sign send intent. Acceptance is not signature completion.

    Prerequisites
    • Grower chooses reached dealer/account and inquiry terms; dealer uses inbox/request review and editor. Commands carry revision/submission identities declared in schemas.
    • Use latest proposal revision, applicable actor, and unexpired deadlines; acceptance requires primary contact email and printable contract.
    Reads
    Writes
    Outputs
    • Inquiry -> requested; issue/replace proposal -> proposed; counter -> requested; decline/withdraw -> terminal states. Accept exact locked proposal -> accepted plus contractId/envelopeId, contract awaiting signature and e-sign send intent. Acceptance is not signature completion.
    Expected refusals and limitations
    • revision/deadline/actor guards; submission_changed; no_email; unprintable error; not_found; forbidden
  3. Quote, create/send a purchase or sale contract; save a target UI supported

    Purchase send returns contractId/envelopeId, sale send saleContractId/envelopeId; awaiting signature. Existing contract send and failed-envelope retry are product operations. saveTarget returns offerId rather than a contract.

    Prerequisites
    • Pick account, crop/deal/contract type, bushels, elevator and delivery/futures terms from builder options. Board/basis reads establish quote context; server samples authoritative quote.
    • Current builder sends create+e-sign atomically via sendNewContract/sendNewSaleContract. createContract remains mounted and flow declared but current route does not emit chooseSide; do not present bare create as current primary button.
    • Signature completion requires vendor/system path; no caller should synthesize it.
    Reads
    Writes
    Outputs
    • Purchase send returns contractId/envelopeId, sale send saleContractId/envelopeId; awaiting signature. Existing contract send and failed-envelope retry are product operations. saveTarget returns offerId rather than a contract.
    Expected refusals and limitations
    • not_price_now/not_set_target; contract_not_sendable; no_email; not_awaiting_sig; target_terms_missing/contradict; target_not_positive; printability refusals
  4. Manage offers and structured products UI supported

    Working offer, cancellation, notification identity, or booked accumulator and period job. Automatic fill/near/period processing are not public human procedures.

    Prerequisites
    • Read book options and authority verdicts. Provide target/expiry/product terms declared by each input.
    Reads
    Writes
    Outputs
    • Working offer, cancellation, notification identity, or booked accumulator and period job. Automatic fill/near/period processing are not public human procedures.
    Expected refusals and limitations
    • target_not_positive; offer_not_near; offer_already_notified; knock_out_not_below; forbidden/no_company
  5. Schedule, arrive and weigh; or create a walk-in ticket UI supported

    scheduleDelivery -> slotId; arrive marks load arrived. enterTicket or enterWalkInTicket -> ticketId in entered state; net/settle/overage derived server-side.

    Prerequisites
    • Schedule uses open signed/active/stored purchase contract, offered bin, delivery date/time and expected bushels. Weigh booked load using slotId; walk-in explicitly picks contractId and bin.
    • Weigh input: grossLb/tareLb/moisture/testWeight/gradeFactors/odor/infested and optional spotPrice/loadSplit. Weights and derived net/settle bushels are different concepts.
    • Optional scan accepts nonempty PDF/JPEG/PNG <=5 MiB and pickId; it returns readings, not a saved ticket. Actual File transport is unmodeled in logical JSON catalog.
    Reads
    Writes
    Outputs
    • scheduleDelivery -> slotId; arrive marks load arrived. enterTicket or enterWalkInTicket -> ticketId in entered state; net/settle/overage derived server-side.
    Expected refusals and limitations
    • contract_not_open; bin_over_capacity; bin_not_offered; slot_received; readings_reversed; grower_is_counterparty; scan parse_failed/no_company
  6. Apply one ticket or allocate it over contracts UI supported

    apply/allocate -> ticketId in applied state; first application can make signed contract active. Allocation leaves excess at spot. Unapply returns applied -> entered with reason.

    Prerequisites
    • Use entered ticket and same grower/crop/grade open contract; appliedBu is explicit. Optional contractId defaults to current contract for whole apply.
    • Allocation uses ordered contract/bushel parts and optional remainder spotPrice. Parts must fit each contract room, sum <= ticket settle bushels, and exclude storage contracts.
    • To reassign an applied load, unapply with reason to return entered, then apply; allocation is not a grain-bin movement.
    Reads
    Writes
    Outputs
    • apply/allocate -> ticketId in applied state; first application can make signed contract active. Allocation leaves excess at spot. Unapply returns applied -> entered with reason.
    Expected refusals and limitations
    • not_entered; not_applied; contract_not_open; grower/crop/grade_mismatch; allocation_storage; allocation_over_room; allocation_over_load
  7. Queue applied contractual loads, issue statements and export to A/P UI supported

    queue: applied -> settlement; pullBack(reason): settlement -> applied. issueStatement returns statementId and records Print/E-sign channel; no email or e-sign delivery. exportSettlement returns batchId/exportId; commits ticket valuations/deductions/advance recoveries, marks tickets settled, and queues accounting work. Clearance status is recorded only after an external accounting notification; this grain API does not initiate a bank payout or clear the batch.

    Prerequisites
    • Applied load, all contractual bushels priced, payable >=0. Queue takes ticketId and queuedOn CalendarDay on/after applied event day in book timezone.
    • Select nonempty ticketIds for one payee on settlement queue. UI loops export once per grower; no caller-entered batch payable/pay terms.
    • Statement and export independently read locked queued selection; do not assume issueStatement is available after the selected tickets have been exported.
    Reads
    Writes
    Outputs
    • queue: applied -> settlement; pullBack(reason): settlement -> applied.
    • issueStatement returns statementId and records Print/E-sign channel; no email or e-sign delivery.
    • exportSettlement returns batchId/exportId; commits ticket valuations/deductions/advance recoveries, marks tickets settled, and queues accounting work. Clearance status is recorded only after an external accounting notification; this grain API does not initiate a bank payout or clear the batch.
    Expected refusals and limitations
    • not_applied; queued_before_applied; not_priced; payable_negative; not_settlement; mixed_payees; no_company; forbidden
  8. Alternative: settle an open delivery to a disposition, then sell storage UI supported

    settleDelivery -> deliverySettlementId, member loads deliverySettled, stored committed figures/pay date according to disposition; storage path can create warehouse receipt. sellFromStorage -> receiptSaleId. This is separate from applied contract-load queue/export. Neither path is a public bank-payment instruction.

    Prerequisites
    • DeliveryRef identifies canonical open delivery from positions read (grower/crop/location or standalone load), with Disposition. Server resolves complete membership; caller cannot submit arbitrary ticket subset.
    • Only entered loads use delivery disposition settlement. They cannot already be applied/queued/settled. Immediate/deferred sale requires price. Storage can retain unpriced figures.
    • sellFromStorage uses existing open receiptId, strictly positive sellBu and cashPrice; sellBu <= remaining.
    Reads
    Writes
    Outputs
    • settleDelivery -> deliverySettlementId, member loads deliverySettled, stored committed figures/pay date according to disposition; storage path can create warehouse receipt. sellFromStorage -> receiptSaleId.
    • This is separate from applied contract-load queue/export. Neither path is a public bank-payment instruction.
    Expected refusals and limitations
    • delivery_mismatch; not_priced; no_company; receipt_open/remaining guards; input validation on nonpositive sale values
  9. Stock movements and shipping UI supported

    Move updates source/destination stock and movement. Ship removes bin bushels for destination/buyer; router explicitly says applied to no sale yet. No exposed procedure here allocates a shipment to sale-contract fulfillment.

    Prerequisites
    • Pick current active source bin, compatible destination or destination/buyer and declared positive bushels; use scoped stock and verdicts.
    Reads
    Writes
    Outputs
    • Move updates source/destination stock and movement. Ship removes bin bushels for destination/buyer; router explicitly says applied to no sale yet. No exposed procedure here allocates a shipment to sale-contract fulfillment.
    Expected refusals and limitations
    • insufficient stock and bin/crop/capacity/authority guards as declared per schema
  10. Service-order lifecycle through recorded customer payment UI supported

    draft -> sent -> signed -> scheduled -> serviced -> invoiced -> paid. createServiceInvoice queues A/R export. payService records received amount, including short/over payments; it does not initiate grower commodity payout.

    Prerequisites
    • Create draft from rate-card/party/service options; send agreement, mark signed or verified e-sign completion; schedule and record actual service. Invoice requires serviced order.
    • Record customer payment for invoiced serviceId with payMethod, amountReceived/dateReceived and optional reference. Charges come from stored invoice.
    Reads
    Writes
    Outputs
    • draft -> sent -> signed -> scheduled -> serviced -> invoiced -> paid. createServiceInvoice queues A/R export. payService records received amount, including short/over payments; it does not initiate grower commodity payout.
    Expected refusals and limitations
    • not_draft/not_sent/not_signed/not_scheduled/not_serviced/not_invoiced; no_email and business guards; forbidden
  11. Grower visibility at the connected dealer UI supported

    Scoped grower share and balances, contract/ticket status, market, documents and settlement clearance. Current handlers gather real domain reads despite stale fixture wording in old flow comments.

    Prerequisites
    • Use the selected dealer and account context; use returned contract and ticket IDs for detail reads.
    Reads
    Writes

    None in this stage.

    Outputs
    • Scoped grower share and balances, contract/ticket status, market, documents and settlement clearance. Current handlers gather real domain reads despite stale fixture wording in old flow comments.
    Expected refusals and limitations
    • Outside dealer reach or another grower record -> not-found; no other payee/lien/whole-load money.
Other boundaries and schema limitations
  • grain.createContract is mounted, but the current contract builder uses grain.sendNewContract or grain.sendNewSaleContract; do not present bare creation as the current primary action.
  • The ticket-extraction procedure returns readings from an uploaded document and does not save a ticket. File bytes and transport are not represented by the logical JSON schema.
  • No human procedure in this grain workflow initiates a bank payout or clears a settlement batch. Settlement export queues accounting work; clearance status is recorded only after an external accounting notification.
  • grain.issueStatement records a statement channel but does not itself email or complete an e-signature.
  • grain.shipGrain moves stock for a destination or buyer; no exposed procedure in the reviewed workflow allocates that shipment to sale-contract fulfillment.
  • Automatic offer fill/near/period processing is not exposed as a public human workflow.

323 procedures

account

Customer accounts

Search, create, and inspect customer accounts, with related contact, operation, payment, and catalog-relationship fields.

account.attachPersonBusiness procedure UI supported

Input shape documented

object | object

4 schema notes
  • $ refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.contactFirstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.contactLastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.contactEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"mode":{"type":"string","const":"pick"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"personId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["mode","accountId","personId"]},{"type":"object","properties":{"contactFirstName":{"type":"string","minLength":1,"maxLength":100},"contactLastName":{"type":"string","minLength":1,"maxLength":100},"contactPhone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"contactEmail":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"mode":{"type":"string","const":"create"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"not":{},"x-zod-type":"undefined"},"externalId":{"not":{},"x-zod-type":"undefined"}},"required":["contactFirstName","contactLastName","mode","accountId"]}]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"personId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["personId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"email_in_use"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"phone_in_use"}},"required":["code"],"additionalProperties":false}]},{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
account.attachPersonDedupBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
probeobjectrequired
2 schema notes
  • $.probe.contactName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.probe.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"probe":{"type":"object","properties":{"contactName":{"type":"string","minLength":2},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}}}},"required":["accountId","probe"]}

Output shape documented

object | object

8 schema notes
  • $|1.candidates[]|0.person.firstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.candidates[]|0.person.lastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.candidates[]|0.person.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.candidates[]|1.person.firstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.candidates[]|1.person.lastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.candidates[]|1.person.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.candidates[]|2.firstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.candidates[]|2.lastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"clear"},"remote":{"type":"string","enum":["found","not_found","ambiguous","unknown"]}},"required":["kind","remote"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"matches"},"remote":{"type":"string","enum":["found","not_found","ambiguous","unknown"]},"candidates":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"person":{"type":"object","properties":{"_tag":{"type":"string","enum":["unverified","verified"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"billingAddressId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","id","ownerId","firstName","lastName"],"additionalProperties":false},"ownership":{"type":"string","enum":["mine","other"]},"provenance":{"type":"string","const":"directory"}},"required":["person","ownership","provenance"],"additionalProperties":false},{"type":"object","properties":{"person":{"type":"object","properties":{"_tag":{"type":"string","enum":["unverified","verified"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"billingAddressId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","id","ownerId","firstName","lastName"],"additionalProperties":false},"ownership":{"type":"string","enum":["mine","other"]},"provenance":{"type":"string","const":"both"},"personUuid":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["person","ownership","provenance","personUuid"],"additionalProperties":false},{"type":"object","properties":{"provenance":{"type":"string","const":"usApp"},"personUuid":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100}},"required":["provenance","personUuid","firstName","lastName"],"additionalProperties":false}]},"minItems":1}},"required":["kind","remote","candidates"],"additionalProperties":false}]}
account.byIdBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
idstring (uuid)required
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"]}

Output shape documented

FieldLogical typePresence
_tag"ok" | "restricted"required
idstring (uuid)required
ownerIdstring (uuid)required
contactobject | objectrequired
subjectobject | object | object | objectrequired
namestringrequired
pursuit"none" | "prospect" | "working"required
patronSinceintegermay be omitted
heldarray of "read" | "create" | "restrict" | "reinstate" | "reassign" | "editPayment"required
funnel"contact" | "prospect" | "active" | "customer" | "churned"required
1 schema note
  • $.subject|2.compassCompanyUid runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"_tag":{"type":"string","enum":["ok","restricted"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contact":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"person"},"personId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","personId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"none"}},"required":["kind"],"additionalProperties":false}]},"subject":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"farm"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"company"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","companyId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"manufacturer"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"compassCompanyUid":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["kind","companyId","compassCompanyUid"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"distributor"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","companyId"],"additionalProperties":false}]},"name":{"type":"string","minLength":1,"maxLength":255},"pursuit":{"type":"string","enum":["none","prospect","working"],"format":"enum"},"patronSince":{"type":"integer","minimum":1850,"maximum":2100},"held":{"type":"array","items":{"type":"string","enum":["read","create","restrict","reinstate","reassign","editPayment"]}},"funnel":{"type":"string","enum":["contact","prospect","active","customer","churned"]}},"required":["_tag","id","ownerId","contact","subject","name","pursuit","held","funnel"],"additionalProperties":false}
account.catalogSharesBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
idstring (uuid)required
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"]}

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sku":{"type":"string","minLength":1,"maxLength":64},"productName":{"type":"string","minLength":1,"maxLength":255},"soldAs":{"type":"string","minLength":1,"maxLength":255},"offered":{"type":"boolean"}},"required":["catalogItemId","sku","productName","soldAs","offered"],"additionalProperties":false}}
account.connectAvailabilityBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
memberEmailstring (email)required
Full logical schema
{"type":"object","properties":{"memberEmail":{"type":"string","maxLength":320,"format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"required":["memberEmail"]}

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","maxLength":320,"format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"required":["email"],"additionalProperties":false},"maxItems":1}
account.createBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
targetobject | objectrequired
pursuit"none" | "prospect" | "working"may be omitted
contactobject | objectrequired
5 schema notes
  • $ refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.target|0.entityType runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contact|0.contactFirstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contact|0.contactLastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contact|0.contactEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"target":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"farm","format":"enum"},"entityName":{"type":"string","minLength":1,"maxLength":255},"entityType":{"anyOf":[{"type":"string","const":"dba"},{"type":"string","enum":["llc","general_partnership","limited_partnership","corporation","joint_venture","trust"],"format":"enum"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"payMethod":{"type":"string","enum":["ACH","Check"]},"paymentTerms":{"type":"string","minLength":1,"maxLength":255},"patronSince":{"type":"integer","minimum":1850,"maximum":2100}},"required":["kind","entityName"]},{"type":"object","properties":{"kind":{"type":"string","const":"company","format":"enum"},"company":{"oneOf":[{"type":"object","properties":{"mode":{"type":"string","const":"new","format":"enum"},"name":{"type":"string","minLength":1,"maxLength":255}},"required":["mode","name"]},{"type":"object","properties":{"mode":{"type":"string","const":"existing","format":"enum"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["mode","companyId"]},{"type":"object","properties":{"mode":{"type":"string","const":"connect","format":"enum"}},"required":["mode"]}]}},"required":["kind","company"]}]},"pursuit":{"type":"string","enum":["none","prospect","working"],"format":"enum"},"contact":{"oneOf":[{"type":"object","properties":{"contactFirstName":{"type":"string","minLength":1,"maxLength":100},"contactLastName":{"type":"string","minLength":1,"maxLength":100},"contactPhone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"contactEmail":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"mode":{"type":"string","const":"new","format":"enum"}},"required":["contactFirstName","contactLastName","mode"]},{"type":"object","properties":{"mode":{"type":"string","const":"existing","format":"enum"},"contactPersonId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["mode","contactPersonId"]}]}},"required":["target","contact"]}

Output shape documented

object | object

1 schema note
  • $|0.value.subject|2.compassCompanyUid runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"_tag":{"type":"string","enum":["ok","restricted"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contact":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"person"},"personId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","personId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"none"}},"required":["kind"],"additionalProperties":false}]},"subject":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"farm"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"company"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","companyId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"manufacturer"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"compassCompanyUid":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["kind","companyId","compassCompanyUid"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"distributor"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","companyId"],"additionalProperties":false}]},"name":{"type":"string","minLength":1,"maxLength":255},"pursuit":{"type":"string","enum":["none","prospect","working"],"format":"enum"},"patronSince":{"type":"integer","minimum":1850,"maximum":2100},"cityState":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]}},"required":["_tag","id","ownerId","contact","subject","name","pursuit","cityState"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"email_in_use"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"phone_in_use"}},"required":["code"],"additionalProperties":false}]},{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"target_unavailable"},"target":{"type":"string","enum":["farm","company"]}},"required":["code","target"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_connectable"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
account.createAvailabilityBusiness procedure UI supported

Input

No input schema declared; no input shape inferred.

Output shape documented

FieldLogical typePresence
heldarray of "read" | "create" | "restrict" | "reinstate" | "reassign" | "editPayment"required
targetKindsarray of "farm" | "company"required
todayCalendarDay | nullrequired
Full logical schema
{"type":"object","properties":{"held":{"type":"array","items":{"type":"string","enum":["read","create","restrict","reinstate","reassign","editPayment"]}},"targetKinds":{"type":"array","items":{"type":"string","enum":["farm","company"]}},"today":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]}},"required":["held","targetKinds","today"],"additionalProperties":false}
account.dedupBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
opNamestringmay be omitted
contactNamestringmay be omitted
phonestring (phone)may be omitted
emailstring (email)may be omitted
side"sell" | "buy"may be omitted
4 schema notes
  • $.opName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contactName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.side runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"opName":{"type":"string","minLength":2},"contactName":{"type":"string","minLength":2},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"side":{"type":"string","enum":["sell","buy"]}}}

Output shape documented

object | object

4 schema notes
  • $|1.accounts[].subject|2.compassCompanyUid runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.contacts[].person.firstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.contacts[].person.lastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.contacts[].person.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"clear"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"matches"},"accounts":{"type":"array","items":{"type":"object","properties":{"_tag":{"type":"string","enum":["ok","restricted"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contact":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"person"},"personId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","personId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"none"}},"required":["kind"],"additionalProperties":false}]},"subject":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"farm"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"company"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","companyId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"manufacturer"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"compassCompanyUid":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["kind","companyId","compassCompanyUid"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"distributor"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","companyId"],"additionalProperties":false}]},"name":{"type":"string","minLength":1,"maxLength":255},"pursuit":{"type":"string","enum":["none","prospect","working"],"format":"enum"},"patronSince":{"type":"integer","minimum":1850,"maximum":2100}},"required":["_tag","id","ownerId","contact","subject","name","pursuit"],"additionalProperties":false}},"contacts":{"type":"array","items":{"type":"object","properties":{"person":{"type":"object","properties":{"_tag":{"type":"string","enum":["unverified","verified"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"billingAddressId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","id","ownerId","firstName","lastName"],"additionalProperties":false},"ownership":{"type":"string","enum":["mine","other"]}},"required":["person","ownership"],"additionalProperties":false}}},"required":["kind","accounts","contacts"],"additionalProperties":false}]}
account.detachPersonBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
personIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"personId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["accountId","personId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"personId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["personId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"on_open_application"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
account.editPaymentBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
idstring (uuid)required
payMethod"ACH" | "Check"required
paymentTermsstringrequired
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"payMethod":{"type":"string","enum":["ACH","Check"]},"paymentTerms":{"type":"string","minLength":1,"maxLength":255}},"required":["id","payMethod","paymentTerms"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_ok"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
account.facetsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
matchobject | objectmay be omitted
side"sell" | "buy" | "all"may be omitted
buyerOnly"include" | "exclude"may be omitted
standing"all" | "ok" | "restricted"may be omitted
ownerobject | objectmay be omitted
targetobject | objectmay be omitted
sort"recentlyCreated" | "oldestFirst" | "nameAsc"may be omitted
limitintegermay be omitted
cursorstring | nullmay be omitted
11 schema notes
  • $.match|1.q refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.match runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.side runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.buyerOnly runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.standing runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.owner runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.target runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sort runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"match":{"oneOf":[{"type":"object","properties":{"by":{"type":"string","const":"none"}},"required":["by"]},{"type":"object","properties":{"by":{"type":"string","const":"text"},"q":{"type":"string","minLength":1}},"required":["by","q"]}]},"side":{"type":"string","enum":["sell","buy","all"]},"buyerOnly":{"type":"string","enum":["include","exclude"]},"standing":{"type":"string","enum":["all","ok","restricted"]},"owner":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"any"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"only"},"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","userId"]}]},"target":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"any"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"only"},"target":{"type":"string","enum":["farm","company"]}},"required":["kind","target"]}]},"sort":{"type":"string","enum":["recentlyCreated","oldestFirst","nameAsc"]},"limit":{"type":"integer","minimum":1,"maximum":200},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}}}

Output shape documented

FieldLogical typePresence
allintegerrequired
okintegerrequired
restrictedintegerrequired
Full logical schema
{"type":"object","properties":{"all":{"type":"integer","minimum":0,"maximum":9007199254740991},"ok":{"type":"integer","minimum":0,"maximum":9007199254740991},"restricted":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["all","ok","restricted"],"additionalProperties":false}
account.financingPanelBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["accountId"]}

Output shape documented

FieldLogical typePresence
cardarray of object | object | object | object | objectrequired
linesarray of objectrequired
loansarray of objectrequired
availableToDrawinteger (money) | nullrequired
entryobject | object | objectrequired
financeBaseUrlstringrequired
Full logical schema
{"type":"object","properties":{"card":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"affordance":{"type":"string","const":"resume"},"applicationId":{"type":"string","minLength":1},"label":{"type":"string"}},"required":["affordance","applicationId","label"],"additionalProperties":false},{"type":"object","properties":{"affordance":{"type":"string","const":"apply"},"cropYear":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"label":{"type":"string"}},"required":["affordance","cropYear","label"],"additionalProperties":false},{"type":"object","properties":{"affordance":{"type":"string","const":"continue"},"financingUuid":{"type":"string","minLength":1,"maxLength":128},"requested":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"label":{"type":"string"}},"required":["affordance","financingUuid","label"],"additionalProperties":false},{"type":"object","properties":{"affordance":{"type":"string","const":"view"},"line":{"type":"object","properties":{"ref":{"type":"string","minLength":1,"maxLength":128},"cropYear":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"type":"string","enum":["active","closed"]},"approved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"drawn":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"available":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["ref","status","approved","drawn","available"],"additionalProperties":false},"current":{"type":"boolean"},"label":{"type":"string"}},"required":["affordance","line","current","label"],"additionalProperties":false},{"type":"object","properties":{"affordance":{"type":"string","const":"denied"},"label":{"type":"string"}},"required":["affordance","label"],"additionalProperties":false}]}},"lines":{"type":"array","items":{"type":"object","properties":{"ref":{"type":"string","minLength":1,"maxLength":128},"cropYear":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"type":"string","enum":["active","closed"]},"approved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"drawn":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"available":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["ref","status","approved","drawn","available"],"additionalProperties":false}},"loans":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"line":{"type":"object","properties":{"ref":{"type":"string","minLength":1,"maxLength":128},"cropYear":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"type":"string","enum":["active","closed"]},"approved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"drawn":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"available":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["ref","status","approved","drawn","available"],"additionalProperties":false},"drawState":{"anyOf":[{"type":"string","enum":["open","closed"]},{"type":"null"}]},"current":{"type":"boolean"}},"required":["id","line","drawState","current"],"additionalProperties":false}},"availableToDraw":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"entry":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"continue"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"apply"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"refused"},"reason":{"type":"string","enum":["company","forbidden","pending","approved"]}},"required":["kind","reason"],"additionalProperties":false}]},"financeBaseUrl":{"type":"string"}},"required":["card","lines","loans","availableToDraw","entry","financeBaseUrl"],"additionalProperties":false}
account.financingPickSearchBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
qstringrequired
buyerOnly"include" | "exclude"may be omitted
Full logical schema
{"type":"object","properties":{"q":{"type":"string"},"buyerOnly":{"type":"string","enum":["include","exclude"]}},"required":["q"]}

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"_tag":{"type":"string","enum":["ok","restricted"]},"name":{"type":"string","minLength":1,"maxLength":255},"contactName":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"contactPhone":{"anyOf":[{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},{"type":"null"}]},"cityState":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"patronSince":{"anyOf":[{"type":"integer","minimum":1850,"maximum":2100},{"type":"null"}]},"kindLabel":{"type":"string","minLength":1,"maxLength":255},"financingEntry":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"continue"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"apply"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"refused"},"reason":{"type":"string","enum":["company","forbidden","pending","approved"]}},"required":["kind","reason"],"additionalProperties":false}]}},"required":["id","_tag","name","contactName","contactPhone","cityState","patronSince","kindLabel","financingEntry"],"additionalProperties":false}}
account.operationBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
idstring (uuid)required
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"]}

Output shape documented

object | null

Full logical schema
{"anyOf":[{"type":"object","properties":{"farmId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"estimatedAcres":{"type":"number","exclusiveMinimum":0,"maximum":200000,"format":"number"},"aggregate":{"type":"object","properties":{"totalAcres":{"anyOf":[{"type":"number","const":0},{"type":"number","exclusiveMinimum":0,"maximum":200000,"format":"number"}]},"cropMix":{"type":"array","items":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]}},"fieldCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["totalAcres","cropMix","fieldCount"],"additionalProperties":false},"fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"crop":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]},"acreage":{"type":"number","exclusiveMinimum":0,"maximum":200000,"format":"number"},"locationAddressId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"address":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"shipTo":{"anyOf":[{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false},{"type":"null"}]}},"required":["id","crop","acreage","address","shipTo"],"additionalProperties":false}}},"required":["farmId","aggregate","fields"],"additionalProperties":false},{"type":"null"}]}
account.pickByIdBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
idstring (uuid)required
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"]}

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"_tag":{"type":"string","enum":["ok","restricted"]},"name":{"type":"string","minLength":1,"maxLength":255},"contactName":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"contactPhone":{"anyOf":[{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},{"type":"null"}]},"cityState":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"patronSince":{"anyOf":[{"type":"integer","minimum":1850,"maximum":2100},{"type":"null"}]}},"required":["id","_tag","name","contactName","contactPhone","cityState","patronSince"],"additionalProperties":false}}
account.pickSearchBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
qstringrequired
buyerOnly"include" | "exclude"may be omitted
Full logical schema
{"type":"object","properties":{"q":{"type":"string"},"buyerOnly":{"type":"string","enum":["include","exclude"]}},"required":["q"]}

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"_tag":{"type":"string","enum":["ok","restricted"]},"name":{"type":"string","minLength":1,"maxLength":255},"contactName":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"contactPhone":{"anyOf":[{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},{"type":"null"}]},"cityState":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"patronSince":{"anyOf":[{"type":"integer","minimum":1850,"maximum":2100},{"type":"null"}]}},"required":["id","_tag","name","contactName","contactPhone","cityState","patronSince"],"additionalProperties":false}}
account.reassignBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
newOwnerIdstring (uuid)required
reasonstringrequired
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"newOwnerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reason":{"type":"string","minLength":1,"maxLength":5000}},"required":["accountId","newOwnerId","reason"]}

Output shape documented

object | object

1 schema note
  • $|0.value.subject|2.compassCompanyUid runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"_tag":{"type":"string","enum":["ok","restricted"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contact":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"person"},"personId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","personId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"none"}},"required":["kind"],"additionalProperties":false}]},"subject":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"farm"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"company"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","companyId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"manufacturer"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"compassCompanyUid":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["kind","companyId","compassCompanyUid"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"distributor"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","companyId"],"additionalProperties":false}]},"name":{"type":"string","minLength":1,"maxLength":255},"pursuit":{"type":"string","enum":["none","prospect","working"],"format":"enum"},"patronSince":{"type":"integer","minimum":1850,"maximum":2100},"held":{"type":"array","items":{"type":"string","enum":["read","create","restrict","reinstate","reassign","editPayment"]}},"funnel":{"type":"string","enum":["contact","prospect","active","customer","churned"]}},"required":["_tag","id","ownerId","contact","subject","name","pursuit","held","funnel"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false}},"required":["ok","error"],"additionalProperties":false}]}
account.recordOpeningBalanceBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
amountinteger (money)required
netDaysintegerrequired
dueAtCalendarDayrequired
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"netDays":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"dueAt":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["accountId","amount","netDays","dueAt"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["chargeId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
account.reinstateBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
idstring (uuid)required
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_restricted"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
account.restrictBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
idstring (uuid)required
reasonstringrequired
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reason":{"type":"string","minLength":1,"maxLength":5000}},"required":["id","reason"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_ok"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
account.searchBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
matchobject | objectmay be omitted
side"sell" | "buy" | "all"may be omitted
buyerOnly"include" | "exclude"may be omitted
standing"all" | "ok" | "restricted"may be omitted
ownerobject | objectmay be omitted
targetobject | objectmay be omitted
sort"recentlyCreated" | "oldestFirst" | "nameAsc"may be omitted
limitintegermay be omitted
cursorstring | nullmay be omitted
11 schema notes
  • $.match|1.q refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.match runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.side runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.buyerOnly runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.standing runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.owner runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.target runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sort runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"match":{"oneOf":[{"type":"object","properties":{"by":{"type":"string","const":"none"}},"required":["by"]},{"type":"object","properties":{"by":{"type":"string","const":"text"},"q":{"type":"string","minLength":1}},"required":["by","q"]}]},"side":{"type":"string","enum":["sell","buy","all"]},"buyerOnly":{"type":"string","enum":["include","exclude"]},"standing":{"type":"string","enum":["all","ok","restricted"]},"owner":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"any"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"only"},"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","userId"]}]},"target":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"any"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"only"},"target":{"type":"string","enum":["farm","company"]}},"required":["kind","target"]}]},"sort":{"type":"string","enum":["recentlyCreated","oldestFirst","nameAsc"]},"limit":{"type":"integer","minimum":1,"maximum":200},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}}}

Output shape documented

array of object

1 schema note
  • $[].subject|2.compassCompanyUid runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"array","items":{"type":"object","properties":{"_tag":{"type":"string","enum":["ok","restricted"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contact":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"person"},"personId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","personId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"none"}},"required":["kind"],"additionalProperties":false}]},"subject":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"farm"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"company"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","companyId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"manufacturer"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"compassCompanyUid":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["kind","companyId","compassCompanyUid"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"distributor"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","companyId"],"additionalProperties":false}]},"name":{"type":"string","minLength":1,"maxLength":255},"pursuit":{"type":"string","enum":["none","prospect","working"],"format":"enum"},"patronSince":{"type":"integer","minimum":1850,"maximum":2100},"held":{"type":"array","items":{"type":"string","enum":["read","create","restrict","reinstate","reassign","editPayment"]}},"kindLabel":{"type":"string","minLength":1,"maxLength":255},"funnel":{"type":"string","enum":["contact","prospect","active","customer","churned"]},"ytdSpend":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"statusLabel":{"type":"string","minLength":1,"maxLength":255},"openDealsLabel":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"lastTouchAt":{"anyOf":[{"type":"string","format":"date-time","x-wire-kind":"Instant"},{"type":"null"}]},"acres":{"anyOf":[{"type":"number","const":0},{"type":"number","exclusiveMinimum":0,"maximum":200000,"format":"number"}]},"region":{"type":"array","items":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]}},"location":{"anyOf":[{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"resolved"},"cityState":{"type":"string","minLength":1,"maxLength":255},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]}},"required":["_tag","cityState","state"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"not_resolvable"}},"required":["_tag"],"additionalProperties":false}]},{"type":"null"}]},"financing":{"anyOf":[{"oneOf":[{"type":"object","properties":{"state":{"type":"string","const":"unknown"}},"required":["state"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"none"}},"required":["state"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"draft"}},"required":["state"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"pending"},"requested":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["state"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"available"},"available":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["state","available"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"declined"}},"required":["state"],"additionalProperties":false}]},{"type":"null"}]},"financingEntry":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"continue"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"apply"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"refused"},"reason":{"type":"string","enum":["company","forbidden","pending","approved"]}},"required":["kind","reason"],"additionalProperties":false}]},"financingRefreshDue":{"type":"boolean"}},"required":["_tag","id","ownerId","contact","subject","name","pursuit","held","kindLabel","funnel","ytdSpend","statusLabel","openDealsLabel","lastTouchAt","acres","region","location","financing","financingEntry","financingRefreshDue"],"additionalProperties":false}}
account.searchCompaniesBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
qstringrequired
Full logical schema
{"type":"object","properties":{"q":{"type":"string","minLength":1,"maxLength":255}},"required":["q"]}

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255}},"required":["id","name"],"additionalProperties":false}}
account.searchWithFacetsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
matchobject | objectmay be omitted
side"sell" | "buy" | "all"may be omitted
buyerOnly"include" | "exclude"may be omitted
standing"all" | "ok" | "restricted"may be omitted
ownerobject | objectmay be omitted
targetobject | objectmay be omitted
sort"recentlyCreated" | "oldestFirst" | "nameAsc"may be omitted
limitintegermay be omitted
cursorstring | nullmay be omitted
11 schema notes
  • $.match|1.q refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.match runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.side runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.buyerOnly runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.standing runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.owner runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.target runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sort runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"match":{"oneOf":[{"type":"object","properties":{"by":{"type":"string","const":"none"}},"required":["by"]},{"type":"object","properties":{"by":{"type":"string","const":"text"},"q":{"type":"string","minLength":1}},"required":["by","q"]}]},"side":{"type":"string","enum":["sell","buy","all"]},"buyerOnly":{"type":"string","enum":["include","exclude"]},"standing":{"type":"string","enum":["all","ok","restricted"]},"owner":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"any"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"only"},"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","userId"]}]},"target":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"any"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"only"},"target":{"type":"string","enum":["farm","company"]}},"required":["kind","target"]}]},"sort":{"type":"string","enum":["recentlyCreated","oldestFirst","nameAsc"]},"limit":{"type":"integer","minimum":1,"maximum":200},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
totalintegerrequired
nextCursorstring | nullrequired
facetsobjectrequired
1 schema note
  • $.rows[].subject|2.compassCompanyUid runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"_tag":{"type":"string","enum":["ok","restricted"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contact":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"person"},"personId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","personId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"none"}},"required":["kind"],"additionalProperties":false}]},"subject":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"farm"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"company"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","companyId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"manufacturer"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"compassCompanyUid":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["kind","companyId","compassCompanyUid"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"distributor"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","companyId"],"additionalProperties":false}]},"name":{"type":"string","minLength":1,"maxLength":255},"pursuit":{"type":"string","enum":["none","prospect","working"],"format":"enum"},"patronSince":{"type":"integer","minimum":1850,"maximum":2100},"held":{"type":"array","items":{"type":"string","enum":["read","create","restrict","reinstate","reassign","editPayment"]}},"kindLabel":{"type":"string","minLength":1,"maxLength":255},"funnel":{"type":"string","enum":["contact","prospect","active","customer","churned"]},"ytdSpend":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"statusLabel":{"type":"string","minLength":1,"maxLength":255},"openDealsLabel":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"lastTouchAt":{"anyOf":[{"type":"string","format":"date-time","x-wire-kind":"Instant"},{"type":"null"}]},"acres":{"anyOf":[{"type":"number","const":0},{"type":"number","exclusiveMinimum":0,"maximum":200000,"format":"number"}]},"region":{"type":"array","items":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]}},"location":{"anyOf":[{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"resolved"},"cityState":{"type":"string","minLength":1,"maxLength":255},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]}},"required":["_tag","cityState","state"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"not_resolvable"}},"required":["_tag"],"additionalProperties":false}]},{"type":"null"}]},"financing":{"anyOf":[{"oneOf":[{"type":"object","properties":{"state":{"type":"string","const":"unknown"}},"required":["state"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"none"}},"required":["state"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"draft"}},"required":["state"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"pending"},"requested":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["state"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"available"},"available":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["state","available"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"declined"}},"required":["state"],"additionalProperties":false}]},{"type":"null"}]},"financingEntry":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"continue"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"apply"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"refused"},"reason":{"type":"string","enum":["company","forbidden","pending","approved"]}},"required":["kind","reason"],"additionalProperties":false}]},"financingRefreshDue":{"type":"boolean"}},"required":["_tag","id","ownerId","contact","subject","name","pursuit","held","kindLabel","funnel","ytdSpend","statusLabel","openDealsLabel","lastTouchAt","acres","region","location","financing","financingEntry","financingRefreshDue"],"additionalProperties":false}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"facets":{"type":"object","properties":{"all":{"type":"integer","minimum":0,"maximum":9007199254740991},"mine":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["all","mine"],"additionalProperties":false}},"required":["rows","total","nextCursor","facets"],"additionalProperties":false}
account.setItemSharedBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
toCompanyIdstring (uuid)required
catalogItemIdstring (uuid)required
sharedbooleanrequired
Full logical schema
{"type":"object","properties":{"toCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"shared":{"type":"boolean"}},"required":["toCompanyId","catalogItemId","shared"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"itemShareEventId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["itemShareEventId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"item_not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"blend_not_shared"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
account.shareCatalogBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
toCompanyIdstring (uuid)required
surface"catalog"required
Full logical schema
{"type":"object","properties":{"toCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"surface":{"type":"string","enum":["catalog"]}},"required":["toCompanyId","surface"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"shareEventId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["shareEventId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"cannot_share_with_self"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
account.shareStandingsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
idstring (uuid)required
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"]}

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"standing":{"type":"string","enum":["not_shared","shared_pending","connected"]},"label":{"type":"string","minLength":1,"maxLength":255},"surface":{"type":"string","enum":["catalog"]}},"required":["standing","label","surface"],"additionalProperties":false}}
account.supplierOrdersBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
idstring (uuid)required
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"]}

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"orderLabel":{"type":"string","minLength":1,"maxLength":255},"progressLabel":{"type":"string","minLength":1,"maxLength":255},"statusLabel":{"type":"string","minLength":1,"maxLength":255}},"required":["saleOrderId","orderLabel","progressLabel","statusLabel"],"additionalProperties":false}}
account.unshareCatalogBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
toCompanyIdstring (uuid)required
surface"catalog"required
Full logical schema
{"type":"object","properties":{"toCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"surface":{"type":"string","enum":["catalog"]}},"required":["toCompanyId","surface"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"shareEventId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["shareEventId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"cannot_share_with_self"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}

address

Address lookup

Resolve and suggest address fields used in business records.

address.resolveBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
placeIdstringrequired
sessionTokenstringrequired
Full logical schema
{"type":"object","properties":{"placeId":{"type":"string","minLength":1},"sessionToken":{"type":"string","minLength":1}},"required":["placeId","sessionToken"]}

Output shape documented

object | null

Full logical schema
{"anyOf":[{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}},"additionalProperties":false},{"type":"null"}]}
address.suggestBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
querystringrequired
sessionTokenstringrequired
Full logical schema
{"type":"object","properties":{"query":{"type":"string","minLength":3},"sessionToken":{"type":"string","minLength":1}},"required":["query","sessionToken"]}

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"placeId":{"type":"string","minLength":1},"text":{"type":"string","minLength":1},"mainText":{"type":"string","minLength":1}},"required":["placeId","text","mainText"],"additionalProperties":false}}

catalog

Catalog sharing and removals

Field shapes for catalog sharing queries and product-removal results.

catalog.addBusiness procedure UI supported

Input shape documented

object | object

6 schema notes
  • $|0.soldAs|0.pack.value refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.soldAs|1.increment refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.soldAs|1.increment runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.soldAs|0.pack.value refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.soldAs|1.increment refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.soldAs|1.increment runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"soldAs":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"packaged"},"pack":{"type":"object","properties":{"count":{"type":"integer","minimum":1,"maximum":9007199254740991},"value":{"type":"number","exclusiveMinimum":0},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["count","value","unit"]}},"required":["_tag","pack"]},{"type":"object","properties":{"_tag":{"type":"string","const":"measured"},"unit":{"type":"string","enum":["lb","ton","gal","L","bu","cwt","acre"]},"increment":{"type":"number","exclusiveMinimum":0,"exclusiveMaximum":100000000000000}},"required":["_tag","unit"]}]},"price":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"format":"money"},"supplied":{"type":"boolean"},"kind":{"type":"string","const":"existing"},"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["sku","soldAs","kind","productId"]},{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"soldAs":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"packaged"},"pack":{"type":"object","properties":{"count":{"type":"integer","minimum":1,"maximum":9007199254740991},"value":{"type":"number","exclusiveMinimum":0},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["count","value","unit"]}},"required":["_tag","pack"]},{"type":"object","properties":{"_tag":{"type":"string","const":"measured"},"unit":{"type":"string","enum":["lb","ton","gal","L","bu","cwt","acre"]},"increment":{"type":"number","exclusiveMinimum":0,"exclusiveMaximum":100000000000000}},"required":["_tag","unit"]}]},"price":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"format":"money"},"supplied":{"type":"boolean"},"kind":{"type":"string","const":"compass"},"compassUid":{"type":"string","minLength":1}},"required":["sku","soldAs","kind","compassUid"]}]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["catalogItemId","productId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unknown_product"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unknown_compass_product"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"already_carried"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"sku_taken"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"sku_unit_mismatch"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
catalog.createOwnBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
namestringrequired
category"herbicide" | "insecticide" | "fungicide" | "nematicide" | "miticide" | "fumigant" | "biopesticide" | "pgr" | "defoliant" | "desiccant" | "repellent" | "insect_growth_regulator" | "seed_treatment" | "seed_lubricant" | "seed" | "fertilizer" | "micronutrient" | "nutritional" | "manure" | "nitrogen_stabilizer" | "manure_treatment" | "biological" | "inoculant" | "biostimulant" | "adjuvant" | "tank_cleaner" | "equipment" | "service" | "other"required
manufacturerstringmay be omitted
brandstringmay be omitted
skustringrequired
soldAsobject | objectrequired
priceinteger (money)may be omitted
suppliedbooleanmay be omitted
manufacturedbooleanmay be omitted
3 schema notes
  • $.soldAs|0.pack.value refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.soldAs|1.increment refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.soldAs|1.increment runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"category":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]},"manufacturer":{"type":"string","minLength":1,"maxLength":255},"brand":{"type":"string","minLength":1,"maxLength":255},"sku":{"type":"string","minLength":1,"maxLength":64},"soldAs":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"packaged"},"pack":{"type":"object","properties":{"count":{"type":"integer","minimum":1,"maximum":9007199254740991},"value":{"type":"number","exclusiveMinimum":0},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["count","value","unit"]}},"required":["_tag","pack"]},{"type":"object","properties":{"_tag":{"type":"string","const":"measured"},"unit":{"type":"string","enum":["lb","ton","gal","L","bu","cwt","acre"]},"increment":{"type":"number","exclusiveMinimum":0,"exclusiveMaximum":100000000000000}},"required":["_tag","unit"]}]},"price":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"format":"money"},"supplied":{"type":"boolean"},"manufactured":{"type":"boolean"}},"required":["name","category","sku","soldAs"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["catalogItemId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"shadows_compass_product"},"compassUid":{"type":"string","minLength":1}},"required":["code","compassUid"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"sku_taken"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
catalog.deleteBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
catalogItemIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["catalogItemId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["catalogItemId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"catalog_item_not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"in_use"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"blend"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"own_product_last"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
catalog.discontinueBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
catalogItemIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["catalogItemId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["catalogItemId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"catalog_item_not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_carried"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
catalog.listBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
limitintegermay be omitted
cursorstring | nullmay be omitted
matchobject | objectmay be omitted
categoryobject | objectmay be omitted
sort"name"may be omitted
productIdstring (uuid)may be omitted
7 schema notes
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.match|1.q refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.match runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.category runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sort runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":200},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"match":{"oneOf":[{"type":"object","properties":{"by":{"type":"string","const":"none"}},"required":["by"]},{"type":"object","properties":{"by":{"type":"string","const":"text"},"q":{"type":"string","minLength":1}},"required":["by","q"]}]},"category":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"any"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"only"},"category":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}},"required":["kind","category"]}]},"sort":{"type":"string","const":"name"},"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
totalintegerrequired
nextCursorstring | nullrequired
facetsobject | objectrequired
2 schema notes
  • $.rows[].pack refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].image refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"manufacturer":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"supplierNames":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"categories":{"type":"array","items":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"saleUnit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"sku":{"type":"string","minLength":1,"maxLength":64},"pack":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"Amount"},{"type":"null"}]},"packCount":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"soldAsDisplay":{"type":"string","minLength":1,"maxLength":255},"productSkuLabel":{"type":"string","minLength":1,"maxLength":374},"price":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"status":{"type":"string","enum":["made","bought","blended","discontinued"]},"statusLabel":{"type":"string","minLength":1,"maxLength":255},"manufactured":{"type":"boolean"},"listable":{"type":"boolean"},"image":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9._-]+(?:\\/[A-Za-z0-9._-]+)*$"},{"type":"null"}]},"imageUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"availability":{"type":"string","enum":["inStock","pending","unavailable","noSupplier"]},"supplyOffered":{"type":"boolean"},"purchaseOffered":{"type":"boolean"}},"required":["catalogItemId","productId","name","manufacturer","supplierNames","categories","unit","saleUnit","sku","pack","packCount","soldAsDisplay","productSkuLabel","price","status","statusLabel","manufactured","listable","image","imageUrl","availability","supplyOffered","purchaseOffered"],"additionalProperties":false}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"facets":{"anyOf":[{"type":"object","properties":{"mine":{"type":"integer","minimum":0,"maximum":9007199254740991},"shared":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["mine","shared"],"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false}]}},"required":["rows","total","nextCursor","facets"],"additionalProperties":false}
catalog.removalsRead catalog removal options. UI supported

Input shape documented

FieldLogical typePresence
productIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["productId"]}

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"removal":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"delete"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"kept"},"why":{"type":"string","enum":["blend","in_use","own_product_last"]},"offer":{"type":"string","enum":["discontinue","none"]}},"required":["kind","why","offer"],"additionalProperties":false}]}},"required":["catalogItemId","removal"],"additionalProperties":false}}
catalog.setImageBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
catalogItemIdstring (uuid)required
imagestringrequired
1 schema note
  • $.image refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"image":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9._-]+(?:\\/[A-Za-z0-9._-]+)*$"}},"required":["catalogItemId","image"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["catalogItemId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"catalog_item_not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"foreign_ref"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
catalog.setManufacturedBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
catalogItemIdstring (uuid)required
manufacturedbooleanrequired
Full logical schema
{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"manufactured":{"type":"boolean"}},"required":["catalogItemId","manufactured"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["catalogItemId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"catalog_item_not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_carried"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"has_supplier"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"is_blend"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
catalog.setPriceBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
catalogItemIdstring (uuid)required
priceinteger (money)required
Full logical schema
{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"price":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"format":"money"}},"required":["catalogItemId","price"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"listPriceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["listPriceId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"catalog_item_not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"blend_priced_by_ingredients"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
catalog.sharedRead shared catalog items. UI supported

Input shape documented

FieldLogical typePresence
limitintegermay be omitted
cursorstring | nullmay be omitted
matchobject | objectmay be omitted
categoryobject | objectmay be omitted
manufacturerobject | objectmay be omitted
carrying"any" | "carrying" | "notCarrying"may be omitted
sort"name"may be omitted
10 schema notes
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.match|1.q refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.match runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.category runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.manufacturer|1.q refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.manufacturer runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.carrying runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sort runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":200},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"match":{"oneOf":[{"type":"object","properties":{"by":{"type":"string","const":"none"}},"required":["by"]},{"type":"object","properties":{"by":{"type":"string","const":"text"},"q":{"type":"string","minLength":1}},"required":["by","q"]}]},"category":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"any"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"only"},"category":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}},"required":["kind","category"]}]},"manufacturer":{"oneOf":[{"type":"object","properties":{"by":{"type":"string","const":"none"}},"required":["by"]},{"type":"object","properties":{"by":{"type":"string","const":"text"},"q":{"type":"string","minLength":1}},"required":["by","q"]}]},"carrying":{"type":"string","enum":["any","carrying","notCarrying"]},"sort":{"type":"string","const":"name"}}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
totalintegerrequired
nextCursorstring | nullrequired
facetsobject | objectrequired
1 schema note
  • $.rows[].pack refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"manufacturer":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"categories":{"type":"array","items":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"saleUnit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"sku":{"type":"string","minLength":1,"maxLength":64},"pack":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"Amount"},{"type":"null"}]},"packCount":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"soldAsDisplay":{"type":"string","minLength":1,"maxLength":255},"supplierName":{"type":"string","minLength":1,"maxLength":255},"carrying":{"type":"string","enum":["carrying","notCarrying"]},"carryingLabel":{"type":"string","minLength":1,"maxLength":255}},"required":["catalogItemId","productId","name","manufacturer","categories","unit","saleUnit","sku","pack","packCount","soldAsDisplay","supplierName","carrying","carryingLabel"],"additionalProperties":false}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"facets":{"anyOf":[{"type":"object","properties":{"mine":{"type":"integer","minimum":0,"maximum":9007199254740991},"shared":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["mine","shared"],"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false}]}},"required":["rows","total","nextCursor","facets"],"additionalProperties":false}

company

Company profile and settings

Company branding and business-setting query and update fields.

company.brandingBusiness procedure UI supported

Input

No input schema declared; no input shape inferred.

Output shape documented

object | null

1 schema note
  • $.logo refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"anyOf":[{"type":"object","properties":{"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},{"type":"null"}]},"address":{"anyOf":[{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false},{"type":"null"}]},"logo":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9._-]+(?:\\/[A-Za-z0-9._-]+)*$"},{"type":"null"}]},"logoUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"can":{"type":"array","items":{"type":"string","enum":["setBrandingContact","setBrandingLogo"]}}},"required":["companyId","name","phone","address","logo","logoUrl","can"],"additionalProperties":false},{"type":"null"}]}
company.setBrandingBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
namestringrequired
phonestring (phone)may be omitted
addressobjectmay be omitted
1 schema note
  • $.name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"]}},"required":["name"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["companyId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
company.setLogoBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
logostringrequired
1 schema note
  • $.logo refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"logo":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9._-]+(?:\\/[A-Za-z0-9._-]+)*$"}},"required":["logo"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["companyId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"foreign_ref"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
company.setSettingsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
sellToCompaniesbooleanmay be omitted
timeZonestringmay be omitted
deliveryWorkflowsarray of "deliveryTracking"may be omitted
2 schema notes
  • $.timeZone refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.deliveryWorkflows refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"sellToCompanies":{"type":"boolean"},"timeZone":{"type":"string"},"deliveryWorkflows":{"type":"array","items":{"type":"string","enum":["deliveryTracking"],"format":"enum"},"maxItems":1}}}

Output shape documented

object | object

5 schema notes
  • $|0.value.sellToCompanies runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.timeZone refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.timeZone runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.deliveryWorkflows refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.deliveryWorkflows runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"_tag":{"type":"string","const":"settings"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sellToCompanies":{"type":"boolean"},"timeZone":{"type":"string"},"deliveryWorkflows":{"type":"array","items":{"type":"string","enum":["deliveryTracking"],"format":"enum"},"maxItems":1}},"required":["_tag","companyId","sellToCompanies","timeZone","deliveryWorkflows"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
company.settingsBusiness procedure UI supported

Input

No input schema declared; no input shape inferred.

Output shape documented

object | null

5 schema notes
  • $.sellToCompanies runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.timeZone refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.timeZone runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.deliveryWorkflows refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.deliveryWorkflows runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"anyOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"settings"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sellToCompanies":{"type":"boolean"},"timeZone":{"type":"string"},"deliveryWorkflows":{"type":"array","items":{"type":"string","enum":["deliveryTracking"],"format":"enum"},"maxItems":1},"displayName":{"type":"string","minLength":1,"maxLength":255},"logoUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"can":{"type":"array","items":{"type":"string","enum":["enableCompanySales","disableCompanySales","setTimeZone","setDeliveryWorkflows"]}}},"required":["_tag","companyId","sellToCompanies","timeZone","deliveryWorkflows","displayName","logoUrl","can"],"additionalProperties":false},{"type":"null"}]}

crm

Customer import

Customer-source counts, import progress, preview, planning, and import result fields.

crm.confirmCustomerImportBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
picksarray of objectrequired
10 schema notes
  • $.picks refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.picks[].source.firstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.picks[].source.lastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.picks[].source.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.picks[].source.farmName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.picks[].source.farmName runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.picks[].facts.person.firstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.picks[].facts.person.lastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.picks[].facts.person.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.picks[].afterSave.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"picks":{"type":"array","items":{"type":"object","properties":{"ref":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"standing":{"type":"string","enum":["new","changed"]},"source":{"type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"address":{"type":"object","properties":{"street":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}}},"farmName":{"type":"string"}},"required":["firstName","lastName"]},"facts":{"type":"object","properties":{"person":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"externalId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["id","companyId","firstName","lastName"]},{"type":"null"}]},"account":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"externalId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contactPersonId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id","companyId","contactPersonId"]},{"type":"null"}]},"farm":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"externalId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255}},"required":["id","accountId","name"]},{"type":"null"}]}},"required":["person","account","farm"]},"afterSave":{"type":"object","properties":{"email":{"anyOf":[{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},{"type":"null"}]},"billingAddress":{"anyOf":[{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"type":"string","minLength":1,"maxLength":255},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","city","state","zip"]},{"type":"null"}]},"farm":{"type":"string","minLength":1,"maxLength":255}},"required":["email","phone","billingAddress","farm"]}},"required":["ref","standing","source","facts","afterSave"]},"maxItems":5000}},"required":["picks"]}

Output shape documented

object | object

8 schema notes
  • $|1.error|2.rows[].source.firstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|2.rows[].source.lastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|2.rows[].source.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|2.rows[].source.farmName runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|2.rows[].facts.person.firstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|2.rows[].facts.person.lastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|2.rows[].facts.person.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|2.rows[].afterSave.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"imported":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"skipped":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refreshed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unmatched":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["imported","skipped","refreshed","unmatched"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false}]}]},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"unauthorized"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unavailable"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false}]},{"type":"object","properties":{"code":{"type":"string","const":"changed_since_preview"},"rows":{"type":"array","items":{"type":"object","properties":{"ref":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"standing":{"type":"string","enum":["new","already_here","changed"]},"source":{"type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"address":{"type":"object","properties":{"street":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"additionalProperties":false},"farmName":{"anyOf":[{"type":"string","const":""},{"type":"string","minLength":1,"maxLength":255}]}},"required":["firstName","lastName"],"additionalProperties":false},"facts":{"type":"object","properties":{"person":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"externalId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["id","companyId","firstName","lastName"],"additionalProperties":false},{"type":"null"}]},"account":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"externalId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contactPersonId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id","companyId","contactPersonId"],"additionalProperties":false},{"type":"null"}]},"farm":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"externalId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255}},"required":["id","accountId","name"],"additionalProperties":false},{"type":"null"}]}},"required":["person","account","farm"],"additionalProperties":false},"afterSave":{"type":"object","properties":{"email":{"anyOf":[{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},{"type":"null"}]},"billingAddress":{"anyOf":[{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"type":"string","minLength":1,"maxLength":255},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","city","state","zip"],"additionalProperties":false},{"type":"null"}]},"farm":{"type":"string","minLength":1,"maxLength":255}},"required":["email","phone","billingAddress","farm"],"additionalProperties":false}},"required":["ref","standing","source","facts","afterSave"],"additionalProperties":false},"minItems":1,"maxItems":5000}},"required":["code","rows"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
crm.countUnsyncedBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
cropYearintegermay be omitted
limitintegermay be omitted
Full logical schema
{"type":"object","properties":{"cropYear":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}}

Output shape documented

FieldLogical typePresence
countintegerrequired
Full logical schema
{"type":"object","properties":{"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["count"],"additionalProperties":false}
crm.customerBookBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
Full logical schema
{"type":"object","properties":{},"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"customers":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["customers"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
crm.importCustomersBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
cropYearintegermay be omitted
limitintegermay be omitted
Full logical schema
{"type":"object","properties":{"cropYear":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"imported":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"skipped":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"refreshed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unmatched":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["imported","skipped","refreshed","unmatched"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false}]}]},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"unauthorized"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unavailable"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
crm.importGrowersCsvBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
rowsarray of objectrequired
4 schema notes
  • $.rows[] refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].firstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].lastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"street":{"type":"string","minLength":1,"maxLength":255},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"},"farmName":{"type":"string","minLength":1,"maxLength":255},"acres":{"type":"number","exclusiveMinimum":0,"maximum":200000,"multipleOf":0.01,"format":"number"}},"required":["firstName","lastName"]},"minItems":1}},"required":["rows"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"imported":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"skipped":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["imported","skipped"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
crm.importProgressBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
Full logical schema
{"type":"object","properties":{},"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"completedFeeds":{"type":"object","properties":{"connectedFi":{"type":"string","format":"date-time","x-zod-type":"date"},"spreadsheet":{"type":"string","format":"date-time","x-zod-type":"date"}},"additionalProperties":false},"next":{"type":"string","enum":["connectedFi","spreadsheet","completed"]}},"required":["completedFeeds","next"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
crm.previewCustomersBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
Full logical schema
{"type":"object","properties":{},"additionalProperties":false}

Output shape documented

object | object

12 schema notes
  • $|0.value.rows[]|0.pick.source.firstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.rows[]|0.pick.source.lastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.rows[]|0.pick.source.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.rows[]|0.pick.source.farmName runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.rows[]|0.pick.facts.person.firstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.rows[]|0.pick.facts.person.lastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.rows[]|0.pick.facts.person.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.rows[]|0.pick.afterSave.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.rows[]|1.source.firstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.rows[]|1.source.lastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.rows[]|1.source.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.rows[]|1.source.farmName runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"rows":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"pick":{"type":"object","properties":{"ref":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"standing":{"type":"string","enum":["new","already_here","changed"]},"source":{"type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"address":{"type":"object","properties":{"street":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"additionalProperties":false},"farmName":{"anyOf":[{"type":"string","const":""},{"type":"string","minLength":1,"maxLength":255}]}},"required":["firstName","lastName"],"additionalProperties":false},"facts":{"type":"object","properties":{"person":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"externalId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["id","companyId","firstName","lastName"],"additionalProperties":false},{"type":"null"}]},"account":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"externalId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contactPersonId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id","companyId","contactPersonId"],"additionalProperties":false},{"type":"null"}]},"farm":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"externalId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255}},"required":["id","accountId","name"],"additionalProperties":false},{"type":"null"}]}},"required":["person","account","farm"],"additionalProperties":false},"afterSave":{"type":"object","properties":{"email":{"anyOf":[{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},{"type":"null"}]},"billingAddress":{"anyOf":[{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"type":"string","minLength":1,"maxLength":255},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","city","state","zip"],"additionalProperties":false},{"type":"null"}]},"farm":{"type":"string","minLength":1,"maxLength":255}},"required":["email","phone","billingAddress","farm"],"additionalProperties":false}},"required":["ref","standing","source","facts","afterSave"],"additionalProperties":false}},"required":["pick"],"additionalProperties":false},{"type":"object","properties":{"ref":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"standing":{"type":"string","const":"unmatched"},"source":{"type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"address":{"type":"object","properties":{"street":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"additionalProperties":false},"farmName":{"anyOf":[{"type":"string","const":""},{"type":"string","minLength":1,"maxLength":255}]}},"required":["firstName","lastName"],"additionalProperties":false},"match":{"type":"object","properties":{"code":{"type":"string","const":"identity_match_required"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"externalId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}]},"reason":{"type":"string","enum":["multiple_contacts","different_key","multiple_accounts","outside_scope"]},"personIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"accountIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["code","companyId","externalId","reason","personIds","accountIds"],"additionalProperties":false}},"required":["ref","standing","source","match"],"additionalProperties":false}]},"maxItems":5000},"counts":{"type":"object","properties":{"new":{"type":"integer","minimum":0,"maximum":9007199254740991},"already_here":{"type":"integer","minimum":0,"maximum":9007199254740991},"changed":{"type":"integer","minimum":0,"maximum":9007199254740991},"unmatched":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["new","already_here","changed","unmatched"],"additionalProperties":false},"invalid":{"type":"array","items":{"type":"object","properties":{"personRef":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"firstName":{"type":"string","maxLength":200},"lastName":{"type":"string","maxLength":200},"issues":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["personRef","firstName","lastName","email","phone","address","farmName"]},"message":{"type":"string","maxLength":500}},"required":["field","message"],"additionalProperties":false},"minItems":1,"maxItems":7}},"required":["personRef","firstName","lastName","issues"],"additionalProperties":false},"maxItems":5000}},"required":["rows","counts","invalid"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false}]}]},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"unauthorized"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unavailable"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
crm.resetImportProgressBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
Full logical schema
{"type":"object","properties":{},"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"completedFeeds":{"type":"object","properties":{"connectedFi":{"type":"string","format":"date-time","x-zod-type":"date"},"spreadsheet":{"type":"string","format":"date-time","x-zod-type":"date"}},"additionalProperties":false},"next":{"type":"string","enum":["connectedFi","spreadsheet","completed"]}},"required":["completedFeeds","next"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
crm.smartImportPlanBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
headersarray of stringrequired
samplearray of objectrequired
unmatchedarray of objectrequired
rejectionsarray of objectrequired
offsetintegerrequired
nextinteger | nullrequired
appliedarray of objectrequired
messagestringmay be omitted
Full logical schema
{"type":"object","properties":{"headers":{"type":"array","items":{"type":"string"}},"sample":{"type":"array","items":{"type":"object","properties":{"row":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"cells":{"type":"array","items":{"type":"string"}}},"required":["row","cells"]},"maxItems":10},"unmatched":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"},"rows":{"type":"array","items":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"minItems":1}},"required":["field","value","rows"]}},"rejections":{"type":"array","items":{"type":"object","properties":{"row":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"message":{"type":"string"},"reason":{"type":"string","enum":["invalid_row"]},"path":{"type":"string"}},"required":["row","message","reason"]},"maxItems":50},"offset":{"type":"integer","minimum":0,"maximum":9007199254740991},"next":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"null"}]},"applied":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":64},"change":{"oneOf":[{"type":"object","properties":{"op":{"type":"string","const":"mapping"},"column":{"type":"integer","minimum":0,"maximum":9007199254740991},"field":{"type":"string"}},"required":["op","column","field"]},{"type":"object","properties":{"op":{"type":"string","const":"enumMap"},"field":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"}},"required":["op","field","from","to"]}]},"rows":{"type":"array","items":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}}},"required":["id","change","rows"]}},"message":{"type":"string"}},"required":["headers","sample","unmatched","rejections","offset","next","applied"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"anyOf":[{"type":"object","properties":{"mapping":{"type":"array","items":{"type":"object","properties":{"column":{"type":"integer","minimum":0,"maximum":9007199254740991},"field":{"type":"string","enum":["firstName","lastName","email","phone","street","city","state","zip","farmName","acres"]}},"required":["column","field"],"additionalProperties":false},"maxItems":200},"enumMaps":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["firstName","lastName","email","phone","street","city","state","zip","farmName","acres"]},"from":{"type":"string","minLength":1},"to":{"type":"string","minLength":1}},"required":["field","from","to"],"additionalProperties":false},"maxItems":200},"undo":{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"maxItems":200},"say":{"type":"string","maxLength":2000}},"required":["mapping","enumMaps","undo","say"],"additionalProperties":false},{"type":"object","properties":{"unusable":{"type":"boolean","const":true},"why":{"type":"string","minLength":1,"maxLength":500}},"required":["unusable","why"],"additionalProperties":false}]}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false}]}]},{"type":"object","properties":{"code":{"type":"string","const":"unavailable"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}

dashboard

Dashboard summaries

Today-view data and pinned-dashboard item and count shapes.

dashboard.pinnedBusiness procedure Backend only

Input

No input schema declared; no input shape inferred.

Output shape documented

array of object

1 schema note
  • $[].bodyText runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"array","items":{"type":"object","properties":{"pinnedNoteId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"interactionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["note","call","email","visit","follow_up"]},"kindLabel":{"type":"string","minLength":1,"maxLength":255},"bodyText":{"type":"string","maxLength":5000},"pinnedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"}},"required":["pinnedNoteId","interactionId","accountId","kind","kindLabel","bodyText","pinnedAt"],"additionalProperties":false}}
dashboard.pinnedCountBusiness procedure Backend only

Input

No input schema declared; no input shape inferred.

Output shape documented

FieldLogical typePresence
totalintegerrequired
Full logical schema
{"type":"object","properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["total"],"additionalProperties":false}
dashboard.todayBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
Full logical schema
{"type":"object","properties":{}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["unsentQuotes","acceptedDeals","unconfirmedPlans","unpaidInvoices","windowRequests","notifications"]},"label":{"type":"string","minLength":1,"maxLength":255},"count":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"href":{"type":"string","enum":["/quotes?tab=unsent","/quotes?tab=accepted","/orders?tab=unconfirmed","/invoices?lens=unpaid","/work","/?notifications=open"]}},"required":["key","label","count","href"],"additionalProperties":false},"minItems":6,"maxItems":6}},"required":["rows"],"additionalProperties":false}

deal

Deals and quotes

Deal records, quote stages, opportunity summaries, and invoice-import fields.

deal.acceptQuoteBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealIdstring (uuid)required
acceptedVia"phone" | "email" | "inPerson" | "text"required
acceptanceNotestringmay be omitted
1 schema note
  • $.acceptanceNote runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"acceptedVia":{"type":"string","enum":["phone","email","inPerson","text"]},"acceptanceNote":{"type":"string","maxLength":5000}},"required":["dealId","acceptedVia"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"deal":{"type":"object","properties":{"_tag":{"type":"string","enum":["request","quote","accept","closedWon","closedLost"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string","minLength":1,"maxLength":255}},"required":["_tag","id","accountId","title"],"additionalProperties":false},"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["deal","saleOrderId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_quote"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_current_quote"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"quote_expired"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
deal.activeObjectCountsByAccountBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["accountId"]}

Output shape documented

FieldLogical typePresence
quotesintegerrequired
ordersintegerrequired
Full logical schema
{"type":"object","properties":{"quotes":{"type":"integer","minimum":0,"maximum":9007199254740991},"orders":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["quotes","orders"],"additionalProperties":false}
deal.byIdBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
idstring (uuid)required
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"]}

Output shape documented

FieldLogical typePresence
_tag"request" | "quote" | "accept" | "closedWon" | "closedLost"required
idstring (uuid)required
accountIdstring (uuid)required
titlestringrequired
heldarray of "read" | "create" | "reassign" | "stageQuote" | "reviseQuote" | "advanceToAccept" | "win" | "lose" | "discard"required
verdictsobjectrequired
quoteStatus"request" | "notSent" | "awaitingAcceptance" | "accepted" | "declined" | "order" | "won" | "lost"required
acceptanceobject | nullrequired
accountEmailstring (email) | nullrequired
accountTelstring (phone) | nullrequired
orderNumberinteger (counter) | nullrequired
declineWordsstringmay be omitted
2 schema notes
  • $.acceptance.acceptanceNote runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.accountEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"_tag":{"type":"string","enum":["request","quote","accept","closedWon","closedLost"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string","minLength":1,"maxLength":255},"held":{"type":"array","items":{"type":"string","enum":["read","create","reassign","stageQuote","reviseQuote","advanceToAccept","win","lose","discard"]}},"verdicts":{"type":"object","properties":{"stageQuote":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["unpriceable_line","not_fulfilled","not_invoiced","not_paid","not_discardable"]}},"required":["status","error"],"additionalProperties":false}]},"lose":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["unpriceable_line","not_fulfilled","not_invoiced","not_paid","not_discardable"]}},"required":["status","error"],"additionalProperties":false}]},"advanceToAccept":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["unpriceable_line","not_fulfilled","not_invoiced","not_paid","not_discardable"]}},"required":["status","error"],"additionalProperties":false}]},"reviseQuote":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["unpriceable_line","not_fulfilled","not_invoiced","not_paid","not_discardable"]}},"required":["status","error"],"additionalProperties":false}]},"win":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["unpriceable_line","not_fulfilled","not_invoiced","not_paid","not_discardable"]}},"required":["status","error"],"additionalProperties":false}]},"discard":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["unpriceable_line","not_fulfilled","not_invoiced","not_paid","not_discardable"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["stageQuote","lose","advanceToAccept","reviseQuote","win","discard"],"additionalProperties":false},"quoteStatus":{"type":"string","enum":["request","notSent","awaitingAcceptance","accepted","declined","order","won","lost"],"format":"enum"},"acceptance":{"anyOf":[{"type":"object","properties":{"acceptedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"acceptedVia":{"type":"string","enum":["phone","email","inPerson","text","imported","direct","storefront","portal"]},"acceptanceNote":{"type":"string","maxLength":5000}},"required":["acceptedAt","acceptedVia","acceptanceNote"],"additionalProperties":false},{"type":"null"}]},"accountEmail":{"anyOf":[{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"accountTel":{"anyOf":[{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},{"type":"null"}]},"orderNumber":{"anyOf":[{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},{"type":"null"}]},"declineWords":{"type":"string","minLength":1,"maxLength":5000}},"required":["_tag","id","accountId","title","held","verdicts","quoteStatus","acceptance","accountEmail","accountTel","orderNumber"],"additionalProperties":false}
deal.createBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
titlestringrequired
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string","minLength":1,"maxLength":255}},"required":["accountId","title"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"_tag":{"type":"string","enum":["request","quote","accept","closedWon","closedLost"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string","minLength":1,"maxLength":255}},"required":["_tag","id","accountId","title"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"account_restricted"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
deal.dashboardMetricsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
perspective"me" | "team"may be omitted
1 schema note
  • $.perspective runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"perspective":{"type":"string","enum":["me","team"]}}}

Output shape documented

FieldLogical typePresence
pipelineValueobjectrequired
openQuoteCountintegerrequired
newRequestsobjectrequired
closeRateobjectrequired
avgQuoteToOrderDaysobjectrequired
Full logical schema
{"type":"object","properties":{"pipelineValue":{"type":"object","properties":{"booked":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"pending":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["booked","pending"],"additionalProperties":false},"openQuoteCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"newRequests":{"type":"object","properties":{"current":{"type":"integer","minimum":0,"maximum":9007199254740991},"previous":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["current","previous"],"additionalProperties":false},"closeRate":{"type":"object","properties":{"current":{"anyOf":[{"type":"number"},{"type":"null"}]},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"],"additionalProperties":false},"avgQuoteToOrderDays":{"type":"object","properties":{"current":{"anyOf":[{"type":"number"},{"type":"null"}]},"previous":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["current","previous"],"additionalProperties":false}},"required":["pipelineValue","openQuoteCount","newRequests","closeRate","avgQuoteToOrderDays"],"additionalProperties":false}
deal.discardBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"_tag":{"type":"string","enum":["request","quote","accept","closedWon","closedLost"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string","minLength":1,"maxLength":255}},"required":["_tag","id","accountId","title"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_discardable"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"has_notes"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
deal.discountsByDealBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
dealIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealId"]}

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"_tag":{"type":"string","const":"adjustment"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sellerCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"tier":{"type":"string","enum":["house","counterparty","deal"]},"buyerCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["relative","pinned"]},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"reasonKind":{"type":"string","enum":["price_match","loyalty","supply_driven","volume"]},"reasonNote":{"type":"string","minLength":1,"maxLength":255},"effectiveAt":{"type":"string","format":"date-time","x-zod-type":"date"},"endsAt":{"type":"string","format":"date-time","x-zod-type":"date"}},"required":["_tag","id","companyId","sellerCompanyId","catalogItemId","tier","kind","effectiveAt"],"additionalProperties":false}}
deal.facetsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
matchobject | object | objectmay be omitted
stage"all" | "activeQuote" | "request" | "quote" | "accept"may be omitted
ownerobject | objectmay be omitted
sort"recentlyCreated" | "oldestFirst" | "titleAsc"may be omitted
limitintegermay be omitted
cursorstring | nullmay be omitted
8 schema notes
  • $.match|1.q refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.match runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.stage runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.owner runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sort runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"match":{"oneOf":[{"type":"object","properties":{"by":{"type":"string","const":"none"}},"required":["by"]},{"type":"object","properties":{"by":{"type":"string","const":"text"},"q":{"type":"string","minLength":1}},"required":["by","q"]},{"type":"object","properties":{"by":{"type":"string","const":"account"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["by","accountId"]}]},"stage":{"type":"string","enum":["all","activeQuote","request","quote","accept"]},"owner":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"any"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"only"},"userId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","userId"]}]},"sort":{"type":"string","enum":["recentlyCreated","oldestFirst","titleAsc"]},"limit":{"type":"integer","minimum":1,"maximum":200},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}}}

Output shape documented

FieldLogical typePresence
allintegerrequired
activeQuoteintegerrequired
requestintegerrequired
quoteintegerrequired
acceptintegerrequired
Full logical schema
{"type":"object","properties":{"all":{"type":"integer","minimum":0,"maximum":9007199254740991},"activeQuote":{"type":"integer","minimum":0,"maximum":9007199254740991},"request":{"type":"integer","minimum":0,"maximum":9007199254740991},"quote":{"type":"integer","minimum":0,"maximum":9007199254740991},"accept":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["all","activeQuote","request","quote","accept"],"additionalProperties":false}
deal.generateInvoicePdfBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
chargeIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["chargeId"]}

Output shape documented

object | null

Full logical schema
{"anyOf":[{"type":"object","properties":{"ref":{"type":"string"},"url":{"type":"string"},"fileName":{"type":"string"}},"required":["ref","url","fileName"],"additionalProperties":false},{"type":"null"}]}
deal.growerInvoiceBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
chargeIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["chargeId"]}

Output shape documented

FieldLogical typePresence
documentobjectrequired
labelsobjectrequired
sentAtInstantmay be omitted
brandobjectmay be omitted
dealershipIdstring (uuid)required
returnedinteger (money)may be omitted
4 schema notes
  • $.document.from.repEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.document.contact.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.document.lines[].qty refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.labels.coverage runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"document":{"type":"object","properties":{"ref":{"type":"string"},"issuedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"dueAt":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"terms":{"type":"string"},"due":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"onReceipt"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"by"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false}]},"customerName":{"type":"string"},"orderNumber":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"from":{"type":"object","properties":{"repName":{"type":"string","minLength":1,"maxLength":255},"repEmail":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"dealerName":{"type":"string","minLength":1,"maxLength":255},"dealerPhone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"dealerAddress":{"type":"string","minLength":1}},"required":["repName","repEmail","dealerName"],"additionalProperties":false},"contact":{"type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":255},"name":{"type":"string","minLength":1,"maxLength":255},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"}},"required":["firstName","name"],"additionalProperties":false},"coverage":{"type":"object","properties":{"invoiced":{"type":"integer","minimum":0,"maximum":9007199254740991},"ofLines":{"type":"integer","minimum":0,"maximum":9007199254740991},"notYetInvoiced":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["invoiced","ofLines","notYetInvoiced"],"additionalProperties":false},"lines":{"type":"array","items":{"type":"object","properties":{"lineNo":{"type":"integer","minimum":0,"maximum":9007199254740991},"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"qty":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"listPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"percentOff":{"type":"integer","minimum":1,"maximum":100},"price":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["lineNo","sku","name","qty","price","amount"],"additionalProperties":false}},"listTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"discount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"amountDue":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"memo":{"type":"string"}},"required":["ref","issuedAt","dueAt","terms","due","customerName","lines","listTotal","total","amountDue"],"additionalProperties":false},"labels":{"type":"object","properties":{"topLine":{"type":"string","minLength":1,"maxLength":255},"due":{"type":"string","minLength":1,"maxLength":255},"coverage":{"type":"string","maxLength":5000}},"required":["topLine","due"],"additionalProperties":false},"sentAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"brand":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"logoUrl":{"type":"string","format":"uri"}},"required":["name"],"additionalProperties":false},"dealershipId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"returned":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["document","labels","dealershipId"],"additionalProperties":false}
deal.growerInvoicePdfBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
chargeIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["chargeId"]}

Output shape documented

FieldLogical typePresence
urlstring (uri)required
fileNamestringrequired
Full logical schema
{"type":"object","properties":{"url":{"type":"string","format":"uri"},"fileName":{"type":"string","minLength":1,"maxLength":255}},"required":["url","fileName"],"additionalProperties":false}
deal.growerOrderBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
dealerstring (uuid)required
orderIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"dealer":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealer","orderId"],"additionalProperties":false}

Output shape documented

object | object

16 schema notes
  • $|0.fulfillments[]|0.qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.fulfillments[]|0.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.fulfillments[]|1.qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.fulfillments[]|1.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.fulfillments[]|2.qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.fulfillments[]|2.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.fulfillments[]|3.qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.fulfillments[]|3.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.fulfillments[]|0.qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.fulfillments[]|0.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.fulfillments[]|1.qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.fulfillments[]|1.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.fulfillments[]|2.qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.fulfillments[]|2.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.fulfillments[]|3.qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.fulfillments[]|3.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"open"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"orderNumber":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"acceptedQuoteVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"confirmedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"lines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"ordered":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"fulfilled":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"open":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"cancelled":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"status":{"anyOf":[{"type":"string","enum":["cancelled","fulfilled","inProgress","scheduled","awaitingDate"]},{"type":"null"}]}},"required":["id","sku","name","ordered","fulfilled","open","cancelled","status"],"additionalProperties":false}},"fulfillments":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"open"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"parentLineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"mode":{"type":"string","enum":["delivery","pickup","notRecorded"]},"field":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":255},"crop":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]},"acreage":{"type":"number","exclusiveMinimum":0,"maximum":200000,"format":"number"},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false}},"required":["id","label","crop","acreage","address"],"additionalProperties":false},{"type":"null"}]},"bySupplier":{"type":"boolean"},"windowRequestable":{"type":"boolean"},"standing":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"scheduled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"dispatched"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"delivered"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pickedUp"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"fulfilled"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cancelled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"superseded"}},"required":["kind"],"additionalProperties":false}]}},"required":["_tag","id","lineId","parentLineFulfillmentId","qty","timeWindow","mode","field","bySupplier","windowRequestable","standing"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"fulfilled"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"parentLineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"mode":{"type":"string","enum":["delivery","pickup","notRecorded"]},"field":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":255},"crop":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]},"acreage":{"type":"number","exclusiveMinimum":0,"maximum":200000,"format":"number"},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false}},"required":["id","label","crop","acreage","address"],"additionalProperties":false},{"type":"null"}]},"bySupplier":{"type":"boolean"},"windowRequestable":{"type":"boolean"},"standing":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"scheduled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"dispatched"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"delivered"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pickedUp"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"fulfilled"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cancelled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"superseded"}},"required":["kind"],"additionalProperties":false}]}},"required":["_tag","id","lineId","parentLineFulfillmentId","qty","timeWindow","mode","field","bySupplier","windowRequestable","standing"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"cancelled"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"parentLineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"cancelledAt":{"type":"string","format":"date-time","x-zod-type":"date"},"mode":{"type":"string","enum":["delivery","pickup","notRecorded"]},"field":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":255},"crop":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]},"acreage":{"type":"number","exclusiveMinimum":0,"maximum":200000,"format":"number"},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false}},"required":["id","label","crop","acreage","address"],"additionalProperties":false},{"type":"null"}]},"bySupplier":{"type":"boolean"},"windowRequestable":{"type":"boolean"},"standing":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"scheduled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"dispatched"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"delivered"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pickedUp"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"fulfilled"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cancelled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"superseded"}},"required":["kind"],"additionalProperties":false}]}},"required":["_tag","id","lineId","parentLineFulfillmentId","qty","timeWindow","cancelledAt","mode","field","bySupplier","windowRequestable","standing"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"superseded"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"parentLineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"mode":{"type":"string","enum":["delivery","pickup","notRecorded"]},"field":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":255},"crop":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]},"acreage":{"type":"number","exclusiveMinimum":0,"maximum":200000,"format":"number"},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false}},"required":["id","label","crop","acreage","address"],"additionalProperties":false},{"type":"null"}]},"bySupplier":{"type":"boolean"},"windowRequestable":{"type":"boolean"},"standing":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"scheduled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"dispatched"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"delivered"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pickedUp"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"fulfilled"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cancelled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"superseded"}},"required":["kind"],"additionalProperties":false}]}},"required":["_tag","id","lineId","parentLineFulfillmentId","qty","timeWindow","mode","field","bySupplier","windowRequestable","standing"],"additionalProperties":false}]}},"shipments":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"inTransit"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"carrier":{"type":"string","minLength":1,"maxLength":255},"tracking":{"type":"string","minLength":1,"maxLength":255},"eta":{"type":"string","format":"date-time","x-zod-type":"date"},"shippedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"lineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"statusLabel":{"type":"string","enum":["In transit","Delivered","Received"]}},"required":["_tag","id","lineFulfillmentId","statusLabel"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"received"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"carrier":{"type":"string","minLength":1,"maxLength":255},"tracking":{"type":"string","minLength":1,"maxLength":255},"eta":{"type":"string","format":"date-time","x-zod-type":"date"},"shippedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"receivedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"lineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"statusLabel":{"type":"string","enum":["In transit","Delivered","Received"]}},"required":["_tag","id","receivedAt","lineFulfillmentId","statusLabel"],"additionalProperties":false}]}}},"required":["_tag","id","orderNumber","dealId","acceptedQuoteVersionId","confirmedAt","lines","fulfillments","shipments"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"cancelled"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"orderNumber":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"acceptedQuoteVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"confirmedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"cancelledAt":{"type":"string","format":"date-time","x-zod-type":"date"},"lines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"ordered":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"fulfilled":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"open":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"cancelled":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"status":{"anyOf":[{"type":"string","enum":["cancelled","fulfilled","inProgress","scheduled","awaitingDate"]},{"type":"null"}]}},"required":["id","sku","name","ordered","fulfilled","open","cancelled","status"],"additionalProperties":false}},"fulfillments":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"open"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"parentLineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"mode":{"type":"string","enum":["delivery","pickup","notRecorded"]},"field":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":255},"crop":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]},"acreage":{"type":"number","exclusiveMinimum":0,"maximum":200000,"format":"number"},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false}},"required":["id","label","crop","acreage","address"],"additionalProperties":false},{"type":"null"}]},"bySupplier":{"type":"boolean"},"windowRequestable":{"type":"boolean"},"standing":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"scheduled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"dispatched"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"delivered"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pickedUp"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"fulfilled"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cancelled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"superseded"}},"required":["kind"],"additionalProperties":false}]}},"required":["_tag","id","lineId","parentLineFulfillmentId","qty","timeWindow","mode","field","bySupplier","windowRequestable","standing"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"fulfilled"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"parentLineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"mode":{"type":"string","enum":["delivery","pickup","notRecorded"]},"field":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":255},"crop":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]},"acreage":{"type":"number","exclusiveMinimum":0,"maximum":200000,"format":"number"},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false}},"required":["id","label","crop","acreage","address"],"additionalProperties":false},{"type":"null"}]},"bySupplier":{"type":"boolean"},"windowRequestable":{"type":"boolean"},"standing":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"scheduled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"dispatched"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"delivered"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pickedUp"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"fulfilled"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cancelled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"superseded"}},"required":["kind"],"additionalProperties":false}]}},"required":["_tag","id","lineId","parentLineFulfillmentId","qty","timeWindow","mode","field","bySupplier","windowRequestable","standing"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"cancelled"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"parentLineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"cancelledAt":{"type":"string","format":"date-time","x-zod-type":"date"},"mode":{"type":"string","enum":["delivery","pickup","notRecorded"]},"field":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":255},"crop":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]},"acreage":{"type":"number","exclusiveMinimum":0,"maximum":200000,"format":"number"},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false}},"required":["id","label","crop","acreage","address"],"additionalProperties":false},{"type":"null"}]},"bySupplier":{"type":"boolean"},"windowRequestable":{"type":"boolean"},"standing":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"scheduled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"dispatched"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"delivered"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pickedUp"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"fulfilled"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cancelled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"superseded"}},"required":["kind"],"additionalProperties":false}]}},"required":["_tag","id","lineId","parentLineFulfillmentId","qty","timeWindow","cancelledAt","mode","field","bySupplier","windowRequestable","standing"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"superseded"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"parentLineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"mode":{"type":"string","enum":["delivery","pickup","notRecorded"]},"field":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":255},"crop":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]},"acreage":{"type":"number","exclusiveMinimum":0,"maximum":200000,"format":"number"},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false}},"required":["id","label","crop","acreage","address"],"additionalProperties":false},{"type":"null"}]},"bySupplier":{"type":"boolean"},"windowRequestable":{"type":"boolean"},"standing":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"scheduled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"dispatched"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"delivered"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pickedUp"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"fulfilled"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cancelled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"superseded"}},"required":["kind"],"additionalProperties":false}]}},"required":["_tag","id","lineId","parentLineFulfillmentId","qty","timeWindow","mode","field","bySupplier","windowRequestable","standing"],"additionalProperties":false}]}},"shipments":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"inTransit"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"carrier":{"type":"string","minLength":1,"maxLength":255},"tracking":{"type":"string","minLength":1,"maxLength":255},"eta":{"type":"string","format":"date-time","x-zod-type":"date"},"shippedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"lineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"statusLabel":{"type":"string","enum":["In transit","Delivered","Received"]}},"required":["_tag","id","lineFulfillmentId","statusLabel"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"received"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"carrier":{"type":"string","minLength":1,"maxLength":255},"tracking":{"type":"string","minLength":1,"maxLength":255},"eta":{"type":"string","format":"date-time","x-zod-type":"date"},"shippedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"receivedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"lineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"statusLabel":{"type":"string","enum":["In transit","Delivered","Received"]}},"required":["_tag","id","receivedAt","lineFulfillmentId","statusLabel"],"additionalProperties":false}]}}},"required":["_tag","id","orderNumber","dealId","acceptedQuoteVersionId","confirmedAt","cancelledAt","lines","fulfillments","shipments"],"additionalProperties":false}]}
deal.importInvoiceBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
docstringrequired
invoiceKeystringrequired
issuedAtCalendarDayrequired
fromWarehouseIdstring (uuid)required
invoiceunknown (unconstrained)may be omitted
linesarray of objectrequired
1 schema note
  • $.doc refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"doc":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9._-]+(?:\\/[A-Za-z0-9._-]+)*$"},"invoiceKey":{"type":"string","minLength":1,"maxLength":64},"issuedAt":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"fromWarehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"invoice":{"x-zod-type":"unknown"},"lines":{"type":"array","items":{"type":"object","properties":{"assignment":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"existing"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","catalogItemId"]}]},"price":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"agreed"}},"required":["_tag"]},{"type":"object","properties":{"_tag":{"type":"string","const":"notApplicable"}},"required":["_tag"]},{"type":"object","properties":{"_tag":{"type":"string","const":"mismatch"},"ledger":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"parsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"resolution":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"reprice"}},"required":["_tag"]},{"type":"object","properties":{"_tag":{"type":"string","const":"discount"}},"required":["_tag"]}]}},"required":["_tag","ledger","parsed","resolution"]}]}},"required":["assignment","price"],"additionalProperties":false},"minItems":1}},"required":["accountId","doc","invoiceKey","issuedAt","fromWarehouseId","lines"]}

Output shape documented

object | object

2 schema notes
  • $|1.error|1|10.value refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|1|10.increment refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"fulfillmentIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"chargeIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["dealId","saleOrderId","fulfillmentIds","chargeIds"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"foreign_ref"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unparseable"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unresolved_lines"},"unresolved":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["code","unresolved"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"price_moved"},"sku":{"type":"string"},"shown":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"agreed"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"mismatch"},"ledger":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"parsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","ledger","parsed"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"notApplicable"}},"required":["_tag"],"additionalProperties":false}]},"now":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"agreed"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"mismatch"},"ledger":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"parsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","ledger","parsed"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"notApplicable"}},"required":["_tag"],"additionalProperties":false}]}},"required":["code","sku","shown","now"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"price_settled"},"sku":{"type":"string"},"shown":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"agreed"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"mismatch"},"ledger":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"parsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","ledger","parsed"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"notApplicable"}},"required":["_tag"],"additionalProperties":false}]},"now":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"agreed"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"mismatch"},"ledger":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"parsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","ledger","parsed"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"notApplicable"}},"required":["_tag"],"additionalProperties":false}]}},"required":["code","sku","shown","now"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"price_question_gone"},"sku":{"type":"string"},"shown":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"agreed"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"mismatch"},"ledger":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"parsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","ledger","parsed"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"notApplicable"}},"required":["_tag"],"additionalProperties":false}]},"now":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"agreed"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"mismatch"},"ledger":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"parsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","ledger","parsed"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"notApplicable"}},"required":["_tag"],"additionalProperties":false}]}},"required":["code","sku","shown","now"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"invoice_key_taken"},"invoiceKey":{"type":"string"}},"required":["code","invoiceKey"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"invoiced_in_future"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unbalanced_document"},"expected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"computed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["code","expected","computed"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"off_increment"},"value":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"increment":{"type":"string","format":"decimal","x-wire-kind":"Amount"}},"required":["code","value","increment"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unit_mismatch"},"index":{"type":"integer","minimum":0,"maximum":9007199254740991},"printedUnit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"saleUnit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["code","index","printedUnit","saleUnit"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"item_at_two_prices"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unknown_warehouse"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"order_not_open"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_invoicable"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["code","lineId"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"already_invoiced"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["code","lineId"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"already_selected"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["code","lineId"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_firm_total"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"price_not_agreed"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"document":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"agreed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["code","catalogItemId","document","agreed"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"blend_priced_by_ingredients"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"blend_stocked_by_ingredients"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
deal.importItemSearchBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
matchobject | objectrequired
1 schema note
  • $.match|1.q refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"match":{"oneOf":[{"type":"object","properties":{"by":{"type":"string","const":"none"}},"required":["by"]},{"type":"object","properties":{"by":{"type":"string","const":"text"},"q":{"type":"string","minLength":1}},"required":["by","q"]}]}},"required":["accountId","match"]}

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1,"maxLength":374}},"required":["catalogItemId","label"],"additionalProperties":false}}
deal.importNumberStandingBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
invoiceKeystringrequired
Full logical schema
{"type":"object","properties":{"invoiceKey":{"type":"string","minLength":1,"maxLength":64}},"required":["invoiceKey"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"takenInReach"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"notSeenInReach"}},"required":["_tag"],"additionalProperties":false}]}
deal.importOrderHistoryBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
warehouseIdstring (uuid)required
transactionRefstringrequired
invoiceKeystringrequired
invoicedAtCalendarDayrequired
totalinteger (money)required
linesarray of objectrequired
1 schema note
  • $.lines[].qty refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"transactionRef":{"type":"string","minLength":1,"maxLength":128},"invoiceKey":{"type":"string","minLength":1,"maxLength":64},"invoicedAt":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"lines":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"qty":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unitPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["catalogItemId","qty","unitPrice"]},"minItems":1}},"required":["accountId","warehouseId","transactionRef","invoiceKey","invoicedAt","total","lines"]}

Output shape documented

object | object

2 schema notes
  • $|1.error|0|3.value refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|0|3.increment refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"paymentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealId","saleOrderId","chargeId","paymentId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false}]}]},{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"order_not_open"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_invoicable"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["code","lineId"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"already_invoiced"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["code","lineId"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"already_selected"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["code","lineId"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_firm_total"}},"required":["code"],"additionalProperties":false}]}]},{"type":"object","properties":{"code":{"type":"string","const":"off_increment"},"value":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"increment":{"type":"string","format":"decimal","x-wire-kind":"Amount"}},"required":["code","value","increment"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"blend_stocked_by_ingredients"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"invoice_key_taken"},"invoiceKey":{"type":"string"}},"required":["code","invoiceKey"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"invoiced_in_future"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unbalanced_document"},"expected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"computed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["code","expected","computed"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unknown_warehouse"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["code","warehouseId"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"price_not_agreed"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"document":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"agreed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["code","catalogItemId","document","agreed"],"additionalProperties":false}]}]},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"already_imported"},"transactionRef":{"type":"string"}},"required":["code","transactionRef"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"transaction_ref_unavailable"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
deal.importOrderHistoryPreviewBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
rowsarray of objectrequired
1 schema note
  • $.rows[].quantity refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"product":{"type":"string","minLength":1},"quantity":{"type":"number","exclusiveMinimum":0},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"unitPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"dealer":{"type":"string"},"mainApplicant":{"type":"string","minLength":1},"farmStates":{"type":"string"},"vendor":{"type":"string"},"warehouse":{"type":"string","minLength":1},"invoiceDate":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"invoiceNumber":{"type":"string","minLength":1,"maxLength":64},"transactionId":{"type":"string","minLength":1,"maxLength":128}},"required":["product","quantity","unit","unitPrice","amount","dealer","mainApplicant","farmStates","vendor","warehouse","invoiceDate","invoiceNumber","transactionId"]},"minItems":1}},"required":["rows"]}

Output shape documented

array of object

3 schema notes
  • $[].lines[].qty refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $[].blockers[]|8.qty refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $[].blockers[]|8.increment refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"array","items":{"type":"object","properties":{"transactionRef":{"type":"string","minLength":1,"maxLength":128},"invoiceKey":{"type":"string","minLength":1,"maxLength":64},"invoicedAt":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"applicant":{"type":"string","minLength":1,"maxLength":255},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"warehouse":{"type":"string","minLength":1,"maxLength":255},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lines":{"type":"array","items":{"type":"object","properties":{"product":{"type":"string","minLength":1,"maxLength":255},"qty":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unitPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"resolution":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"stocked"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","catalogItemId"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"catalogued"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","catalogItemId"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"mirrored"},"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","productId"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unknown"}},"required":["_tag"],"additionalProperties":false}]},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sku":{"type":"string","minLength":1,"maxLength":64},"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["product","qty","unitPrice","amount","resolution"],"additionalProperties":false},"minItems":1},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"blockers":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"unmatched_account"},"applicant":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","applicant"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unmatched_warehouse"},"warehouse":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","warehouse"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unresolved_item"},"product":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","product"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"already_imported"},"transactionRef":{"type":"string","minLength":1,"maxLength":128}},"required":["kind","transactionRef"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"invoice_key_taken"},"invoiceKey":{"type":"string","minLength":1,"maxLength":64}},"required":["kind","invoiceKey"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"ambiguous_match"},"field":{"type":"string","enum":["mainApplicant","warehouse","product"]},"value":{"type":"string","minLength":1,"maxLength":255},"matches":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["kind","field","value","matches"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"invoiced_in_future"},"invoicedAt":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","invoicedAt"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"inconsistent_field"},"field":{"type":"string","enum":["mainApplicant","invoiceNumber","invoiceDate","warehouse"]},"values":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255},"minItems":2}},"required":["kind","field","values"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"off_increment"},"product":{"type":"string","minLength":1,"maxLength":255},"qty":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"increment":{"type":"string","format":"decimal","x-wire-kind":"Amount"}},"required":["kind","product","qty","increment"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"line_amount_mismatch"},"product":{"type":"string","minLength":1,"maxLength":255},"stated":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"computed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","product","stated","computed"],"additionalProperties":false}]}}},"required":["transactionRef","invoiceKey","invoicedAt","applicant","warehouse","lines","total","blockers"],"additionalProperties":false}}
deal.importPreviewBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
invoiceunknown (unconstrained)may be omitted
issuedAtCalendarDaymay be omitted
assignmentsarray of objectrequired
suggestionsarray of string (uuid) | nullmay be omitted
1 schema note
  • $.suggestions runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"invoice":{"x-zod-type":"unknown"},"issuedAt":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"assignments":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","minimum":0,"maximum":9007199254740991},"assignment":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"existing"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","catalogItemId"]},{"type":"object","properties":{"_tag":{"type":"string","const":"unmatched"}},"required":["_tag"]}]}},"required":["index","assignment"]}},"suggestions":{"type":"array","items":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}}},"required":["accountId","assignments"]}

Output shape documented

object | object

3 schema notes
  • $|0.issuedAt|1 runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.dueAt|1 runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.lines[].qty refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"invoiceKey":{"type":"string","minLength":1},"issuedAt":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"string","format":"date","x-wire-kind":"CalendarDay"}]},"dueAt":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"string","format":"date","x-wire-kind":"CalendarDay"}]},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"kind":{"type":"string","const":"preview"},"lines":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","minLength":1},"qty":{"type":"number","exclusiveMinimum":0},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"unitPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"resolution":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"stocked"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","catalogItemId"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"catalogued"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","catalogItemId"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"mirrored"},"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","productId"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unknown"}},"required":["_tag"],"additionalProperties":false}]},"match":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"item"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","catalogItemId","productId","sku","name"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"none"}},"required":["kind"],"additionalProperties":false}]},"priced":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"carried"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sku":{"type":"string","minLength":1,"maxLength":64}},"required":["kind","catalogItemId","sku"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unassigned"}},"required":["kind"],"additionalProperties":false}]},"product":{"anyOf":[{"type":"string","minLength":1,"maxLength":374},{"type":"null"}]},"lineTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"unitStanding":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"fits"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unitMismatch"},"printedUnit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"saleUnit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["_tag","printedUnit","saleUnit"],"additionalProperties":false}]},"priceStanding":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"agreed"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"mismatch"},"ledger":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"parsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","ledger","parsed"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"notApplicable"}},"required":["_tag"],"additionalProperties":false}]},"anchoredPrice":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"anchoredAt":{"type":"string","format":"date-time","x-zod-type":"date"},"currentPrice":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"group":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"max"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"twoPrices"}},"required":["kind"],"additionalProperties":false}]}},"required":["description","qty","unit","unitPrice","resolution","match","priced","product","lineTotal","unitStanding","priceStanding","anchoredPrice","anchoredAt","currentPrice","group"],"additionalProperties":false}},"readiness":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"confirmable"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"blocked"},"unresolved":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["_tag","unresolved"],"additionalProperties":false}]}},"required":["total","kind","lines","readiness"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unparseable"},"detail":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","detail"],"additionalProperties":false}]}
deal.importSuggestionsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
invoiceunknown (unconstrained)may be omitted
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"invoice":{"x-zod-type":"unknown"}},"required":["accountId"]}

Output shape documented

FieldLogical typePresence
suggestionsarray of string (uuid) | nullrequired
Full logical schema
{"type":"object","properties":{"suggestions":{"type":"array","items":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}}},"required":["suggestions"],"additionalProperties":false}
deal.journeyBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
idstring (uuid)required
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"]}

Output shape documented

array of object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object

1 schema note
  • $[]|2.to|0[] refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"array","items":{"oneOf":[{"type":"object","properties":{"track":{"type":"string","enum":["quote","order","money","deal"]},"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"actor":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"label":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","const":"deal_opened"},"refId":{"anyOf":[{"type":"null"},{"type":"null"}]}},"required":["track","at","actor","label","kind","refId"],"additionalProperties":false},{"type":"object","properties":{"track":{"type":"string","enum":["quote","order","money","deal"]},"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"actor":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"label":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","const":"quote_staged"},"refId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["track","at","actor","label","kind","refId"],"additionalProperties":false},{"type":"object","properties":{"track":{"type":"string","enum":["quote","order","money","deal"]},"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"actor":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"label":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","const":"quote_sent"},"refId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"channel":{"type":"string","enum":["email","sms","in_app"]},"to":{"anyOf":[{"type":"array","items":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"minItems":1},{"type":"array","prefixItems":[{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"}],"minItems":1,"items":false,"maxItems":1}]}},"required":["track","at","actor","label","kind","refId","channel","to"],"additionalProperties":false},{"type":"object","properties":{"track":{"type":"string","enum":["quote","order","money","deal"]},"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"actor":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"label":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","const":"quote_accepted"},"refId":{"anyOf":[{"type":"null"},{"type":"null"}]}},"required":["track","at","actor","label","kind","refId"],"additionalProperties":false},{"type":"object","properties":{"track":{"type":"string","enum":["quote","order","money","deal"]},"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"actor":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"label":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","const":"order_confirmed"},"refId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["track","at","actor","label","kind","refId"],"additionalProperties":false},{"type":"object","properties":{"track":{"type":"string","enum":["quote","order","money","deal"]},"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"actor":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"label":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","const":"fulfillment_planned"},"refId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["track","at","actor","label","kind","refId"],"additionalProperties":false},{"type":"object","properties":{"track":{"type":"string","enum":["quote","order","money","deal"]},"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"actor":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"label":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","const":"fulfillment_scheduled"},"refId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["track","at","actor","label","kind","refId"],"additionalProperties":false},{"type":"object","properties":{"track":{"type":"string","enum":["quote","order","money","deal"]},"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"actor":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"label":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","const":"fulfillment_shipped"},"refId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["track","at","actor","label","kind","refId"],"additionalProperties":false},{"type":"object","properties":{"track":{"type":"string","enum":["quote","order","money","deal"]},"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"actor":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"label":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","const":"fulfillment_picked_up"},"refId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["track","at","actor","label","kind","refId"],"additionalProperties":false},{"type":"object","properties":{"track":{"type":"string","enum":["quote","order","money","deal"]},"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"actor":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"label":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","const":"fulfillment_completed"},"refId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["track","at","actor","label","kind","refId"],"additionalProperties":false},{"type":"object","properties":{"track":{"type":"string","enum":["quote","order","money","deal"]},"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"actor":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"label":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","const":"fulfillment_cancelled"},"refId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["track","at","actor","label","kind","refId"],"additionalProperties":false},{"type":"object","properties":{"track":{"type":"string","enum":["quote","order","money","deal"]},"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"actor":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"label":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","const":"invoice_issued"},"refId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["track","at","actor","label","kind","refId"],"additionalProperties":false},{"type":"object","properties":{"track":{"type":"string","enum":["quote","order","money","deal"]},"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"actor":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"label":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","const":"payment_recorded"},"refId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["track","at","actor","label","kind","refId"],"additionalProperties":false},{"type":"object","properties":{"track":{"type":"string","enum":["quote","order","money","deal"]},"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"actor":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"label":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","const":"credit_issued"},"refId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["track","at","actor","label","kind","refId"],"additionalProperties":false},{"type":"object","properties":{"track":{"type":"string","enum":["quote","order","money","deal"]},"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"actor":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"label":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","const":"deal_won"},"refId":{"anyOf":[{"type":"null"},{"type":"null"}]}},"required":["track","at","actor","label","kind","refId"],"additionalProperties":false},{"type":"object","properties":{"track":{"type":"string","enum":["quote","order","money","deal"]},"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"actor":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"label":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","const":"deal_lost"},"refId":{"anyOf":[{"type":"null"},{"type":"null"}]}},"required":["track","at","actor","label","kind","refId"],"additionalProperties":false}]}}
deal.loseBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealIdstring (uuid)required
reasonstringrequired
Full logical schema
{"type":"object","properties":{"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reason":{"type":"string","minLength":1}},"required":["dealId","reason"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"_tag":{"type":"string","enum":["request","quote","accept","closedWon","closedLost"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string","minLength":1,"maxLength":255}},"required":["_tag","id","accountId","title"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_open"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
deal.parseInvoiceDocBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
docstringrequired
1 schema note
  • $.doc refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"doc":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9._-]+(?:\\/[A-Za-z0-9._-]+)*$"}},"required":["doc"]}

Output shape documented

object | object

4 schema notes
  • $|0.value refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.issuedAt|1 runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.dueAt|1 runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.lines[].qty refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"invoiceKey":{"type":"string","minLength":1},"issuedAt":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"string","format":"date","x-wire-kind":"CalendarDay"}]},"dueAt":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"string","format":"date","x-wire-kind":"CalendarDay"}]},"lines":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","minLength":1},"code":{"type":"string","minLength":1,"maxLength":64},"qty":{"type":"number","exclusiveMinimum":0},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"unitPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"lineTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["description","qty","unit","unitPrice"],"additionalProperties":false},"minItems":1},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["lines","total"],"additionalProperties":false},"today":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["ok","value","today"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"unparseable"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unavailable"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_company"},"detail":{"type":"string","minLength":1,"maxLength":255}},"required":["code","detail"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
deal.pipelineSnapshotBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
perspective"me" | "team"may be omitted
1 schema note
  • $.perspective runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"perspective":{"type":"string","enum":["me","team"]}}}

Output shape documented

FieldLogical typePresence
stagesarray of objectrequired
Full logical schema
{"type":"object","properties":{"stages":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["request","quote","accept","financing","order","fulfillment"]},"label":{"type":"string","minLength":1,"maxLength":255},"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"value":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"status":{"type":"string","enum":["live","pending"]}},"required":["key","label","count","value","status"],"additionalProperties":false}}},"required":["stages"],"additionalProperties":false}
deal.placeOrderBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealIdstring (uuid)required
linesarray of objectrequired
orderDiscountobjectmay be omitted
pricingJustificationobjectmay be omitted
3 schema notes
  • $.lines[].qty refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[].cut|1.fixed refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.pricingJustification refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lines":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"qty":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"cut":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"relative"},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000}},"required":["kind","adjustBps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pinned"},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","fixed"],"additionalProperties":false}]}},"required":["catalogItemId","qty"]}},"orderDiscount":{"type":"object","properties":{"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"description":{"type":"string","minLength":1,"maxLength":255}},"required":["adjustBps","description"],"additionalProperties":false},"pricingJustification":{"type":"object","properties":{"reasonKind":{"type":"string","enum":["price_match","loyalty","supply_driven","volume"]},"reasonNote":{"type":"string","minLength":1,"maxLength":5000}},"additionalProperties":false}},"required":["dealId","lines"]}

Output shape documented

object | object

2 schema notes
  • $|1.error|0|1.value refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|0|1.increment refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"deal":{"type":"object","properties":{"_tag":{"type":"string","enum":["request","quote","accept","closedWon","closedLost"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string","minLength":1,"maxLength":255}},"required":["_tag","id","accountId","title"],"additionalProperties":false},"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["deal","saleOrderId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"off_increment"},"value":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"increment":{"type":"string","format":"decimal","x-wire-kind":"Amount"}},"required":["code","value","increment"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"duplicate_item"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_request"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"empty_lines"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unpriceable_line"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"discount_exceeds_price"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"line_too_large"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"save_failed"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}]}]},{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_quote"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_current_quote"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"quote_expired"}},"required":["code"],"additionalProperties":false}]}]}]}},"required":["ok","error"],"additionalProperties":false}]}
deal.pricedCatalogBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealId"]}

Output shape documented

array of object

3 schema notes
  • $[].increment refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $[].soldAs|0.pack.size.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $[].soldAs|1.increment refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"categories":{"type":"array","items":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"increment":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"soldAs":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"packaged"},"pack":{"type":"object","properties":{"count":{"type":"integer","minimum":1,"maximum":9007199254740991},"size":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false}},"required":["count","size"],"additionalProperties":false}},"required":["_tag","pack"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"measured"},"unit":{"type":"string","enum":["lb","ton","gal","L","bu","cwt","acre"]},"increment":{"type":"string","format":"decimal","x-wire-kind":"Amount"}},"required":["_tag","unit","increment"],"additionalProperties":false}]},"price":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"pricing":{"anyOf":[{"type":"object","properties":{"msrp":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"net":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["msrp","net"],"additionalProperties":false},{"type":"null"}]},"sellable":{"type":"boolean"},"unsellableReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"stockNote":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["catalogItemId","sku","name","categories","unit","increment","soldAs","price","pricing","sellable","unsellableReason","stockNote"],"additionalProperties":false}}
deal.quoteIndexBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
matchobject | object | objectmay be omitted
accountIdstring (uuid)may be omitted
tab"active" | "all" | "unsent" | "accepted"may be omitted
sort"recentlyCreated" | "oldestFirst" | "titleAsc"may be omitted
limitintegermay be omitted
cursorstring | nullmay be omitted
7 schema notes
  • $.match|1.q refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.match runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tab runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sort runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"match":{"oneOf":[{"type":"object","properties":{"by":{"type":"string","const":"none"}},"required":["by"]},{"type":"object","properties":{"by":{"type":"string","const":"text"},"q":{"type":"string","minLength":1}},"required":["by","q"]},{"type":"object","properties":{"by":{"type":"string","const":"account"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["by","accountId"]}]},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"tab":{"type":"string","enum":["active","all","unsent","accepted"]},"sort":{"type":"string","enum":["recentlyCreated","oldestFirst","titleAsc"]},"limit":{"type":"integer","minimum":1,"maximum":200},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
totalintegerrequired
nextCursorstring | nullrequired
facetsobjectrequired
1 schema note
  • $.rows[].accountEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"quoteName":{"type":"string","minLength":1,"maxLength":255},"orderNumber":{"anyOf":[{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},{"type":"null"}]},"accountName":{"type":"string","minLength":1,"maxLength":255},"contactName":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"farmName":{"type":"string","minLength":1,"maxLength":255},"accountEmail":{"anyOf":[{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"accountTel":{"anyOf":[{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},{"type":"null"}]},"location":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"orderDate":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"quoteTotal":{"anyOf":[{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},{"type":"null"}]},"quoteStatus":{"type":"string","enum":["request","notSent","awaitingAcceptance","accepted","declined","order","won","lost"],"format":"enum"},"_tag":{"type":"string","enum":["request","quote","accept","closedWon","closedLost"]},"held":{"type":"array","items":{"type":"string","enum":["read","create","reassign","stageQuote","reviseQuote","advanceToAccept","win","lose","discard"]}}},"required":["accountId","dealId","quoteName","orderNumber","accountName","contactName","farmName","accountEmail","accountTel","location","orderDate","quoteTotal","quoteStatus","_tag","held"],"additionalProperties":false}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"facets":{"type":"object","properties":{"active":{"type":"integer","minimum":0,"maximum":9007199254740991},"all":{"type":"integer","minimum":0,"maximum":9007199254740991},"unsent":{"type":"integer","minimum":0,"maximum":9007199254740991},"accepted":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["active","all","unsent","accepted"],"additionalProperties":false}},"required":["rows","total","nextCursor","facets"],"additionalProperties":false}
deal.quoteSendPreviewBusiness procedure UI supported

Input shape documented

object | object

1 schema note
  • $|0.customEmail.message runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customEmail":{"type":"object","properties":{"subject":{"type":"string","minLength":1,"maxLength":255},"greeting":{"type":"string","minLength":1,"maxLength":255},"message":{"type":"string","maxLength":5000},"signOff":{"type":"string","minLength":1,"maxLength":255}}},"channel":{"type":"string","enum":["email"]}},"required":["dealId","channel"]},{"type":"object","properties":{"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"channel":{"type":"string","enum":["sms"]}},"required":["dealId","channel"]}]}

Output shape documented

object | object | object | object

3 schema notes
  • $|0|0.recipient.address refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0|0.message runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0|1.recipient.address refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"oneOf":[{"type":"object","properties":{"channel":{"type":"string","enum":["email"]},"_tag":{"type":"string","const":"ready"},"recipient":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"address":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"required":["name","address"],"additionalProperties":false},"subject":{"type":"string","minLength":1},"html":{"type":"string","minLength":1},"message":{"type":"string","maxLength":5000}},"required":["channel","_tag","recipient","subject","html","message"],"additionalProperties":false},{"type":"object","properties":{"channel":{"type":"string","enum":["email"]},"_tag":{"type":"string","const":"refused"},"refusal":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_stageable"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_contact_email"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unpriced"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unbranded"}},"required":["code"],"additionalProperties":false}]}]},"recipient":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"address":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"required":["name","address"],"additionalProperties":false},{"type":"null"}]}},"required":["channel","_tag","refusal","recipient"],"additionalProperties":false}]},{"oneOf":[{"type":"object","properties":{"channel":{"type":"string","enum":["sms"]},"_tag":{"type":"string","const":"ready"},"recipient":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"address":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"}},"required":["name","address"],"additionalProperties":false},"body":{"type":"string","minLength":1}},"required":["channel","_tag","recipient","body"],"additionalProperties":false},{"type":"object","properties":{"channel":{"type":"string","enum":["sms"]},"_tag":{"type":"string","const":"refused"},"refusal":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_stageable"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_phone"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_contact_email"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unpriced"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unbranded"}},"required":["code"],"additionalProperties":false}]}]},"recipient":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"address":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"}},"required":["name","address"],"additionalProperties":false},{"type":"null"}]}},"required":["channel","_tag","refusal","recipient"],"additionalProperties":false}]}]}
deal.reviseQuoteBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealIdstring (uuid)required
notestringrequired
linesarray of objectrequired
orderDiscountobjectmay be omitted
pricingJustificationobjectmay be omitted
validUntilCalendarDaymay be omitted
3 schema notes
  • $.lines[].qty refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[].cut|1.fixed refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.pricingJustification refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"note":{"type":"string","minLength":1,"maxLength":5000},"lines":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"qty":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"cut":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"relative"},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000}},"required":["kind","adjustBps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pinned"},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","fixed"],"additionalProperties":false}]}},"required":["catalogItemId","qty"]}},"orderDiscount":{"type":"object","properties":{"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"description":{"type":"string","minLength":1,"maxLength":255}},"required":["adjustBps","description"],"additionalProperties":false},"pricingJustification":{"type":"object","properties":{"reasonKind":{"type":"string","enum":["price_match","loyalty","supply_driven","volume"]},"reasonNote":{"type":"string","minLength":1,"maxLength":5000}},"additionalProperties":false},"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["dealId","note","lines"]}

Output shape documented

object | object

4 schema notes
  • $|0.value.quote.note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.quote.pricingJustification refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|1.value refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|1.increment refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"deal":{"type":"object","properties":{"_tag":{"type":"string","enum":["request","quote","accept","closedWon","closedLost"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string","minLength":1,"maxLength":255}},"required":["_tag","id","accountId","title"],"additionalProperties":false},"quote":{"type":"object","properties":{"_tag":{"type":"string","enum":["current","superseded","accepted"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"note":{"type":"string","maxLength":5000},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"supersededAt":{"type":"string","format":"date-time","x-zod-type":"date"},"orderDiscount":{"type":"object","properties":{"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"description":{"type":"string","minLength":1,"maxLength":255}},"required":["adjustBps","description"],"additionalProperties":false},"pricingJustification":{"type":"object","properties":{"reasonKind":{"type":"string","enum":["price_match","loyalty","supply_driven","volume"]},"reasonNote":{"type":"string","minLength":1,"maxLength":5000}},"additionalProperties":false}},"required":["_tag","id","dealId","version","validUntil","note","createdAt"],"additionalProperties":false}},"required":["deal","quote"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"off_increment"},"value":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"increment":{"type":"string","format":"decimal","x-wire-kind":"Amount"}},"required":["code","value","increment"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"duplicate_item"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_quote"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_current_quote"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"empty_lines"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unpriceable_line"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"discount_exceeds_price"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"line_too_large"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"note_too_short"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"save_failed"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
deal.sendQuoteEmailBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealIdstring (uuid)required
customEmailobjectmay be omitted
1 schema note
  • $.customEmail.message runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"customEmail":{"type":"object","properties":{"subject":{"type":"string","minLength":1,"maxLength":255},"greeting":{"type":"string","minLength":1,"maxLength":255},"message":{"type":"string","maxLength":5000},"signOff":{"type":"string","minLength":1,"maxLength":255}}}},"required":["dealId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"notificationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["notificationId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_stageable"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_contact_email"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unpriced"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unbranded"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
deal.sendQuoteTextBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"notificationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["notificationId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_stageable"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_phone"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_contact_email"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unpriced"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unbranded"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
deal.stageQuoteBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealIdstring (uuid)required
linesarray of objectrequired
orderDiscountobjectmay be omitted
pricingJustificationobjectmay be omitted
validUntilCalendarDaymay be omitted
3 schema notes
  • $.lines[].qty refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[].cut|1.fixed refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.pricingJustification refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lines":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"qty":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"cut":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"relative"},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000}},"required":["kind","adjustBps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pinned"},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","fixed"],"additionalProperties":false}]}},"required":["catalogItemId","qty"]}},"orderDiscount":{"type":"object","properties":{"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"description":{"type":"string","minLength":1,"maxLength":255}},"required":["adjustBps","description"],"additionalProperties":false},"pricingJustification":{"type":"object","properties":{"reasonKind":{"type":"string","enum":["price_match","loyalty","supply_driven","volume"]},"reasonNote":{"type":"string","minLength":1,"maxLength":5000}},"additionalProperties":false},"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["dealId","lines"]}

Output shape documented

object | object

4 schema notes
  • $|0.value.quote.note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.quote.pricingJustification refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|1.value refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|1.increment refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"deal":{"type":"object","properties":{"_tag":{"type":"string","enum":["request","quote","accept","closedWon","closedLost"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string","minLength":1,"maxLength":255}},"required":["_tag","id","accountId","title"],"additionalProperties":false},"quote":{"type":"object","properties":{"_tag":{"type":"string","enum":["current","superseded","accepted"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"note":{"type":"string","maxLength":5000},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"supersededAt":{"type":"string","format":"date-time","x-zod-type":"date"},"orderDiscount":{"type":"object","properties":{"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"description":{"type":"string","minLength":1,"maxLength":255}},"required":["adjustBps","description"],"additionalProperties":false},"pricingJustification":{"type":"object","properties":{"reasonKind":{"type":"string","enum":["price_match","loyalty","supply_driven","volume"]},"reasonNote":{"type":"string","minLength":1,"maxLength":5000}},"additionalProperties":false}},"required":["_tag","id","dealId","version","validUntil","note","createdAt"],"additionalProperties":false}},"required":["deal","quote"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"off_increment"},"value":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"increment":{"type":"string","format":"decimal","x-wire-kind":"Amount"}},"required":["code","value","increment"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"duplicate_item"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_request"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"empty_lines"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unpriceable_line"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"discount_exceeds_price"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"line_too_large"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"save_failed"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}

deliveryWindowRequest

Delivery date requests

Request, review, and response fields for proposed delivery dates.

deliveryWindowRequest.awaitingBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
Full logical schema
{"type":"object","properties":{},"additionalProperties":false}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
17 schema notes
  • $.rows[].request|0.requestedWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].request|1.requestedWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].request|1.mainWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].request|1.overrides[].timeWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].request|2.requestedWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].request|3.requestedWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].targets[].qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].targets[].timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].targets[].confirmedWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].targets[].delivery|0.qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].targets[].delivery|0.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].targets[].delivery|1.qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].targets[].delivery|1.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].targets[].delivery|2.qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].targets[].delivery|2.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].targets[].delivery|3.qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].targets[].delivery|3.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"request":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"unconfirmed"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sellerCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"fieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requesterUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestedWindow":{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},"submissionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submittedAt":{"type":"string","format":"date-time","x-zod-type":"date"}},"required":["_tag","id","companyId","sellerCompanyId","accountId","fieldId","requesterUserId","requestedWindow","submissionId","submittedAt"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"confirmed"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sellerCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"fieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requesterUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestedWindow":{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},"submissionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submittedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"mainWindow":{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},"overrides":{"type":"array","items":{"type":"object","properties":{"lineFulfillmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"timeWindow":{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false}},"required":["lineFulfillmentId","timeWindow"],"additionalProperties":false}},"confirmedBy":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"confirmedAt":{"type":"string","format":"date-time","x-zod-type":"date"}},"required":["_tag","id","companyId","sellerCompanyId","accountId","fieldId","requesterUserId","requestedWindow","submissionId","submittedAt","mainWindow","overrides","confirmedBy","confirmedAt"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"declined"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sellerCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"fieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requesterUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestedWindow":{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},"submissionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submittedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"declinedBy":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"declinedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"reason":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]}},"required":["_tag","id","companyId","sellerCompanyId","accountId","fieldId","requesterUserId","requestedWindow","submissionId","submittedAt","declinedBy","declinedAt","reason"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"withdrawn"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sellerCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"fieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requesterUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestedWindow":{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},"submissionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submittedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"withdrawnBy":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"withdrawnAt":{"type":"string","format":"date-time","x-zod-type":"date"}},"required":["_tag","id","companyId","sellerCompanyId","accountId","fieldId","requesterUserId","requestedWindow","submissionId","submittedAt","withdrawnBy","withdrawnAt"],"additionalProperties":false}]},"targets":{"type":"array","items":{"type":"object","properties":{"lineFulfillmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"confirmedWindow":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"null"}]},"delivery":{"anyOf":[{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"open"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"parentLineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"plan":{"oneOf":[{"type":"object","properties":{"mode":{"type":"string","const":"delivery"},"destinationFieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"destination":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false}},"required":["mode","destinationFieldId","destination"],"additionalProperties":false},{"type":"object","properties":{"mode":{"type":"string","const":"pickup"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["mode","warehouseId"],"additionalProperties":false}]},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"}},"required":["_tag","id","companyId","saleOrderId","lineId","catalogItemId","parentLineFulfillmentId","qty","plan","timeWindow","note","createdAt"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"fulfilled"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"parentLineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"plan":{"oneOf":[{"type":"object","properties":{"mode":{"type":"string","const":"delivery"},"destinationFieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"destination":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false}},"required":["mode","destinationFieldId","destination"],"additionalProperties":false},{"type":"object","properties":{"mode":{"type":"string","const":"pickup"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["mode","warehouseId"],"additionalProperties":false},{"type":"object","properties":{"mode":{"type":"string","const":"notRecorded"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["mode","warehouseId"],"additionalProperties":false}]},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"fulfilledAt":{"type":"string","format":"date-time","x-zod-type":"date"}},"required":["_tag","id","companyId","saleOrderId","lineId","catalogItemId","parentLineFulfillmentId","qty","plan","timeWindow","note","createdAt","fulfilledAt"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"cancelled"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"parentLineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"plan":{"oneOf":[{"type":"object","properties":{"mode":{"type":"string","const":"delivery"},"destinationFieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"destination":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false}},"required":["mode","destinationFieldId","destination"],"additionalProperties":false},{"type":"object","properties":{"mode":{"type":"string","const":"pickup"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["mode","warehouseId"],"additionalProperties":false}]},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"cancelledAt":{"type":"string","format":"date-time","x-zod-type":"date"},"reason":{"type":"string","minLength":1,"maxLength":5000}},"required":["_tag","id","companyId","saleOrderId","lineId","catalogItemId","parentLineFulfillmentId","qty","plan","timeWindow","note","createdAt","cancelledAt","reason"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"superseded"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"parentLineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"plan":{"oneOf":[{"type":"object","properties":{"mode":{"type":"string","const":"delivery"},"destinationFieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"destination":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false}},"required":["mode","destinationFieldId","destination"],"additionalProperties":false},{"type":"object","properties":{"mode":{"type":"string","const":"pickup"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["mode","warehouseId"],"additionalProperties":false}]},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"supersededAt":{"type":"string","format":"date-time","x-zod-type":"date"}},"required":["_tag","id","companyId","saleOrderId","lineId","catalogItemId","parentLineFulfillmentId","qty","plan","timeWindow","note","createdAt","supersededAt"],"additionalProperties":false}]},{"type":"null"}]},"item":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"sku":{"type":"string","minLength":1,"maxLength":64}},"required":["name","sku"],"additionalProperties":false},{"type":"null"}]}},"required":["lineFulfillmentId","saleOrderId","lineId","qty","timeWindow","confirmedWindow","delivery","item"],"additionalProperties":false}},"today":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"verdicts":{"type":"object","properties":{"confirm":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["override_outside_request","targets_changed"]}},"required":["status","error"],"additionalProperties":false}]},"decline":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["override_outside_request","targets_changed"]}},"required":["status","error"],"additionalProperties":false}]},"withdraw":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["override_outside_request","targets_changed"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["confirm","decline","withdraw"],"additionalProperties":false}},"required":["request","targets","today","verdicts"],"additionalProperties":false}}},"required":["rows"],"additionalProperties":false}
deliveryWindowRequest.confirmBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
requestIdstring (uuid)required
mainWindowobjectrequired
overridesarray of objectrequired
3 schema notes
  • $.mainWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.overrides refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.overrides[].timeWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"mainWindow":{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},"overrides":{"type":"array","items":{"type":"object","properties":{"lineFulfillmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"timeWindow":{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false}},"required":["lineFulfillmentId","timeWindow"],"additionalProperties":false}}},"required":["requestId","mainWindow","overrides"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["requestId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_unconfirmed","override_outside_request","targets_changed","supplier_endpoint_fixed"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
deliveryWindowRequest.declineBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
requestIdstring (uuid)required
reasonstringmay be omitted
Full logical schema
{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["requestId"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["requestId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_unconfirmed"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
deliveryWindowRequest.growerRequestsBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
dealerstring (uuid)required
Full logical schema
{"type":"object","properties":{"dealer":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealer"],"additionalProperties":false}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
9 schema notes
  • $.rows[].request|0.requestedWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].request|1.requestedWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].request|1.mainWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].request|1.overrides[].timeWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].request|2.requestedWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].request|3.requestedWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].targets[].qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].targets[].timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].targets[].confirmedWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"request":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"unconfirmed"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sellerCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"fieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requesterUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestedWindow":{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},"submissionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submittedAt":{"type":"string","format":"date-time","x-zod-type":"date"}},"required":["_tag","id","companyId","sellerCompanyId","accountId","fieldId","requesterUserId","requestedWindow","submissionId","submittedAt"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"confirmed"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sellerCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"fieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requesterUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestedWindow":{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},"submissionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submittedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"mainWindow":{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},"overrides":{"type":"array","items":{"type":"object","properties":{"lineFulfillmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"timeWindow":{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false}},"required":["lineFulfillmentId","timeWindow"],"additionalProperties":false}},"confirmedBy":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"confirmedAt":{"type":"string","format":"date-time","x-zod-type":"date"}},"required":["_tag","id","companyId","sellerCompanyId","accountId","fieldId","requesterUserId","requestedWindow","submissionId","submittedAt","mainWindow","overrides","confirmedBy","confirmedAt"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"declined"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sellerCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"fieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requesterUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestedWindow":{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},"submissionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submittedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"declinedBy":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"declinedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"reason":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]}},"required":["_tag","id","companyId","sellerCompanyId","accountId","fieldId","requesterUserId","requestedWindow","submissionId","submittedAt","declinedBy","declinedAt","reason"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"withdrawn"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sellerCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"fieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requesterUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestedWindow":{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},"submissionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submittedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"withdrawnBy":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"withdrawnAt":{"type":"string","format":"date-time","x-zod-type":"date"}},"required":["_tag","id","companyId","sellerCompanyId","accountId","fieldId","requesterUserId","requestedWindow","submissionId","submittedAt","withdrawnBy","withdrawnAt"],"additionalProperties":false}]},"statusLabel":{"type":"string","minLength":1,"maxLength":255},"receiver":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"targets":{"type":"array","items":{"type":"object","properties":{"lineFulfillmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"confirmedWindow":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"null"}]}},"required":["lineFulfillmentId","saleOrderId","lineId","qty","timeWindow","confirmedWindow"],"additionalProperties":false}},"verdicts":{"type":"object","properties":{"confirm":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["override_outside_request","targets_changed"]}},"required":["status","error"],"additionalProperties":false}]},"decline":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["override_outside_request","targets_changed"]}},"required":["status","error"],"additionalProperties":false}]},"withdraw":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["override_outside_request","targets_changed"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["confirm","decline","withdraw"],"additionalProperties":false}},"required":["request","statusLabel","receiver","targets","verdicts"],"additionalProperties":false}}},"required":["rows"],"additionalProperties":false}
deliveryWindowRequest.sendBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealerstring (uuid)required
fieldIdstring (uuid)required
requestedWindowobjectrequired
submissionKeystringrequired
2 schema notes
  • $.requestedWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.submissionKey refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"dealer":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"fieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestedWindow":{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},"submissionKey":{"type":"string","minLength":1,"maxLength":128}},"required":["dealer","fieldId","requestedWindow","submissionKey"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"submissionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requests":{"type":"array","items":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["requestId","companyId"],"additionalProperties":false}}},"required":["submissionId","requests"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"type":"object","properties":{"code":{"type":"string","enum":["not_found","no_deliveries","deliveries_changed","already_requested","submission_changed"]}},"required":["code"],"additionalProperties":false}},"required":["ok","error"],"additionalProperties":false}]}
deliveryWindowRequest.withdrawBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
requestIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["requestId"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["requestId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_unconfirmed"]}},"required":["code"],"additionalProperties":false}]},{"type":"object","properties":{"code":{"type":"string","const":"not_found"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}

document

Business document lookup

Lookup result fields for documents referenced by business records.

document.byIdsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
idsarray of string (uuid)required
Full logical schema
{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["ids"]}

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"bytes":{"type":"integer","exclusiveMinimum":0,"maximum":52428800},"mime":{"type":"string","enum":["application/pdf","image/png","image/jpeg","image/webp","application/json"]},"uploadedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"uploadedBy":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id","name","bytes","mime","uploadedAt","uploadedBy"],"additionalProperties":false}}

farm

Farms and fields

Farm and field records, including field updates and removal results.

farm.addFieldBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
farmIdstring (uuid)required
namestringmay be omitted
acreagenumber (number)required
crop"Almonds" | "Barley" | "Canola" | "Cherry" | "Corn" | "Cotton" | "Dry (Edible) Beans" | "Millet" | "Milo (Grain Sorghum)" | "Oats" | "Pea (Dry)" | "Peanuts" | "Popcorn" | "Potatoes" | "Rice" | "Soybean" | "Sugar Beets" | "Sunflowers" | "Tobacco" | "Wheat (HRW)" | "Wheat (Spring)" | "Wheat (SRW)" | "Other"required
addressobjectrequired
Full logical schema
{"type":"object","properties":{"farmId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"acreage":{"type":"number","exclusiveMinimum":0,"maximum":200000,"multipleOf":0.01,"format":"number"},"crop":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"]}},"required":["farmId","acreage","crop","address"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"locationAddressId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["fieldId","locationAddressId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"farm_not_found"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
farm.createBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
namestringrequired
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255}},"required":["accountId","name"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"farmId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["farmId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false}},"required":["ok","error"],"additionalProperties":false}]}
farm.removeFieldBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
fieldIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["fieldId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"outcome":{"type":"string","enum":["deleted","retired"]}},"required":["fieldId","outcome"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"field_not_found"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
farm.reviseBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
farmIdstring (uuid)required
namestringrequired
estimatedAcresnumber (number)may be omitted
Full logical schema
{"type":"object","properties":{"farmId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"estimatedAcres":{"type":"number","exclusiveMinimum":0,"maximum":200000,"multipleOf":0.01,"format":"number"}},"required":["farmId","name"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"farmId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["farmId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"farm_not_found"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
farm.reviseFieldBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
fieldIdstring (uuid)required
namestringmay be omitted
acreagenumber (number)required
crop"Almonds" | "Barley" | "Canola" | "Cherry" | "Corn" | "Cotton" | "Dry (Edible) Beans" | "Millet" | "Milo (Grain Sorghum)" | "Oats" | "Pea (Dry)" | "Peanuts" | "Popcorn" | "Potatoes" | "Rice" | "Soybean" | "Sugar Beets" | "Sunflowers" | "Tobacco" | "Wheat (HRW)" | "Wheat (Spring)" | "Wheat (SRW)" | "Other"required
addressobjectrequired
Full logical schema
{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"acreage":{"type":"number","exclusiveMinimum":0,"maximum":200000,"multipleOf":0.01,"format":"number"},"crop":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"]}},"required":["fieldId","acreage","crop","address"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["fieldId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"field_not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_address"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}

financing

Financing support

Financing synchronization and invoice-return context fields.

financing.returnableInvoicesBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
loanRefstringrequired
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"loanRef":{"type":"string","minLength":1,"maxLength":128}},"required":["accountId","loanRef"]}

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"invoiceKey":{"type":"string","minLength":1,"maxLength":64},"trancheId":{"type":"string","minLength":1,"maxLength":128},"trancheLabel":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"returnable":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"lines":{"type":"array","items":{"type":"object","properties":{"orderLineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":{"type":"string","minLength":1,"maxLength":255},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["orderLineId","description","amount"],"additionalProperties":false}}},"required":["chargeId","invoiceKey","trancheId","trancheLabel","returnable","lines"],"additionalProperties":false}}
financing.syncBatchBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdsarray of string (uuid)required
Full logical schema
{"type":"object","properties":{"accountIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["accountIds"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"synced":{"type":"number"}},"required":["synced"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_found"},"entity":{"type":"string"},"ref":{"type":"string"}},"required":["code","entity","ref"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"declined"},"reason":{"type":"string"}},"required":["code","reason"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"insufficient_credit"},"requested":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"available":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"retriable":{"type":"boolean"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"ineligible"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"retriable":{"type":"boolean"}},"required":["code","reason"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"draw_in_progress"},"conflict":{"type":"string","const":"key_reused"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"incomplete"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"entities":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["person","organization","loan"]},"ref":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["kind","ref","errors"],"additionalProperties":false}},"detail":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unauthorized"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unavailable"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"wire_mismatch"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}

grain

Grain contracts, delivery, and services

Fields for grain contracts, offers, market references, delivery schedules and tickets, settlement and positions, storage and elevators, liens, and service orders.

grain.accountGrainBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["accountId"]}

Output shape documented

FieldLogical typePresence
contractsarray of objectrequired
loadsarray of objectrequired
ticketsarray of objectrequired
offersarray of objectrequired
servicesarray of objectrequired
summaryobjectrequired
startsobjectrequired
72 schema notes
  • $.contracts[].party refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contracts[].mode refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contracts[].crop refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contracts[].grade refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contracts[].price refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contracts[].bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contracts[].filledBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contracts[].statusLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.loads[].time refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.loads[].truck refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.loads[].cropShort refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.loads[].loadBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].crop refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].grade refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].farmer refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].contractLine refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].split refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].mode refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].netBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].testWeight.text refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].testWeight.standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].moisture.text refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].moisture.standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].fm.text refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].fm.standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].bcfm.text refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].bcfm.standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].damage.text refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].damage.standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].heatDamage.text refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].heatDamage.standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].splits.text refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].splits.standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].protein.text refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].protein.standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].dockage.text refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].dockage.standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tickets[].destination refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].statusLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].grower refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].cropLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].offerBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].grade refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].terms refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].elevator refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].targetPrice refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].targetLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].basisTarget refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].filledPrice refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].away refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].noteText refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].notifyBrief.title refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].notifyBrief.subtitle refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].notifyBrief.lead refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].notifyBrief.script[] refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].loggedBy refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].comment runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.services[].grower refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.services[].time refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.services[].bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.services[].services refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.services[].statusLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.summary.openBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.summary.weekBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.summary.contractsCaption refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.summary.contractsDescription refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.summary.scheduleValue refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.summary.scheduleCaption refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.summary.offersCaption refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.summary.deliveriesDescription refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.summary.ticketsDescription refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"contracts":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","const":"purchase"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"party":{"type":"string","minLength":1,"maxLength":200},"dealType":{"type":"string","enum":["origination","direct-ship","storage / DP"]},"mode":{"type":"string","minLength":1,"maxLength":200},"crop":{"type":"string","minLength":1,"maxLength":200},"grade":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"price":{"type":"string","minLength":1,"maxLength":200},"bushels":{"type":"number","minimum":0,"maximum":100000000},"filledBu":{"type":"number","minimum":0,"maximum":100000000},"status":{"type":"string","enum":["awaiting-sig","signed","active","expired","filled","stored","cancelled","bought out"]},"statusLabel":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","id","contractNo","party","dealType","mode","crop","grade","price","bushels","filledBu","status","statusLabel"],"additionalProperties":false}},"loads":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"deliveryDate":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"time":{"type":"string","minLength":1,"maxLength":200},"truck":{"type":"string","minLength":1,"maxLength":200},"contractNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"cropShort":{"type":"string","minLength":1,"maxLength":200},"loadBu":{"type":"number","minimum":0,"maximum":100000000},"status":{"type":"string","enum":["scheduled","on scale","received"]}},"required":["id","deliveryDate","time","truck","contractNo","cropShort","loadBu","status"],"additionalProperties":false}},"tickets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ticketNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"day":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"crop":{"type":"string","minLength":1,"maxLength":200},"grade":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"farmer":{"type":"string","minLength":1,"maxLength":200},"contractLine":{"type":"string","minLength":1,"maxLength":200},"contractNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"split":{"type":"string","minLength":1,"maxLength":200},"dealType":{"type":"string","enum":["origination","direct-ship","storage / DP"]},"mode":{"type":"string","minLength":1,"maxLength":200},"netBu":{"type":"number","minimum":0,"maximum":100000000},"testWeight":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":200},"standard":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"offGrade":{"type":"boolean"}},"required":["text","standard","offGrade"],"additionalProperties":false},{"type":"null"}]},"moisture":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":200},"standard":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"offGrade":{"type":"boolean"}},"required":["text","standard","offGrade"],"additionalProperties":false},{"type":"null"}]},"fm":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":200},"standard":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"offGrade":{"type":"boolean"}},"required":["text","standard","offGrade"],"additionalProperties":false},{"type":"null"}]},"bcfm":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":200},"standard":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"offGrade":{"type":"boolean"}},"required":["text","standard","offGrade"],"additionalProperties":false},{"type":"null"}]},"damage":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":200},"standard":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"offGrade":{"type":"boolean"}},"required":["text","standard","offGrade"],"additionalProperties":false},{"type":"null"}]},"heatDamage":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":200},"standard":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"offGrade":{"type":"boolean"}},"required":["text","standard","offGrade"],"additionalProperties":false},{"type":"null"}]},"splits":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":200},"standard":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"offGrade":{"type":"boolean"}},"required":["text","standard","offGrade"],"additionalProperties":false},{"type":"null"}]},"protein":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":200},"standard":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"offGrade":{"type":"boolean"}},"required":["text","standard","offGrade"],"additionalProperties":false},{"type":"null"}]},"dockage":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":200},"standard":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"offGrade":{"type":"boolean"}},"required":["text","standard","offGrade"],"additionalProperties":false},{"type":"null"}]},"destination":{"type":"string","minLength":1,"maxLength":200},"status":{"type":"string","enum":["entered","applied","in settlement","settled"]},"alert":{"anyOf":[{"type":"string","enum":["off-grade","rejected"]},{"type":"null"}]}},"required":["id","ticketNo","day","crop","grade","farmer","contractLine","contractNo","split","dealType","mode","netBu","testWeight","moisture","fm","bcfm","damage","heatDamage","splits","protein","dockage","destination","status","alert"],"additionalProperties":false}},"offers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"offerNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"status":{"type":"string","enum":["working","near","expired","cancelled","triggered"]},"statusLabel":{"type":"string","minLength":1,"maxLength":200},"grower":{"type":"string","minLength":1,"maxLength":200},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"cropLabel":{"type":"string","minLength":1,"maxLength":200},"offerType":{"type":"string","enum":["Cash","Flat","HTA","Basis"]},"offerBu":{"type":"number","minimum":0,"maximum":100000000},"grade":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"duration":{"type":"string","enum":["GTC","Day"]},"futuresMonth":{"type":"string","minLength":1,"maxLength":200},"terms":{"type":"string","minLength":1,"maxLength":200},"elevator":{"type":"string","minLength":1,"maxLength":200},"targetPrice":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"targetLabel":{"type":"string","minLength":1,"maxLength":200},"basisTarget":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"expiration":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"filledPrice":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"market":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"away":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"proximity":{"anyOf":[{"type":"number","minimum":0,"maximum":1},{"type":"null"}]},"note":{"anyOf":[{"type":"string","enum":["extremely close","close","expired"]},{"type":"null"}]},"noteText":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"contractNo":{"anyOf":[{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},{"type":"null"}]},"contractId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"notified":{"type":"boolean"},"notifyBrief":{"anyOf":[{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":200},"subtitle":{"type":"string","minLength":1,"maxLength":200},"lead":{"type":"string","minLength":1,"maxLength":200},"script":{"type":"array","items":{"type":"string","minLength":1,"maxLength":200},"minItems":1,"maxItems":8}},"required":["title","subtitle","lead","script"],"additionalProperties":false},{"type":"null"}]},"loggedBy":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"accountSplit":{"anyOf":[{"type":"string","enum":["Operating account","Landlord split account","Trust account"]},{"type":"null"}]},"deliveryStart":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"deliveryEnd":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"receivedVia":{"anyOf":[{"type":"string","enum":["Phone","Text","Email","In person"]},{"type":"null"}]},"comment":{"type":"string","maxLength":5000},"cancel":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","const":"offer_expired"}},"required":["status","error"],"additionalProperties":false}]},"notify":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","const":"offer_already_notified"}},"required":["status","error"],"additionalProperties":false}]}},"required":["id","offerNo","status","statusLabel","grower","crop","cropLabel","offerType","offerBu","grade","duration","futuresMonth","terms","elevator","targetPrice","targetLabel","basisTarget","expiration","filledPrice","market","away","proximity","note","noteText","contractNo","contractId","notified","notifyBrief","loggedBy","accountSplit","deliveryStart","deliveryEnd","receivedVia","comment","cancel","notify"],"additionalProperties":false}},"services":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"serviceNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"grower":{"type":"string","minLength":1,"maxLength":200},"serviceDate":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"time":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"bushels":{"type":"number","minimum":0,"maximum":100000000},"actual":{"type":"boolean"},"services":{"type":"string","minLength":1,"maxLength":200},"status":{"type":"string","enum":["draft","sent","signed","scheduled","serviced","invoiced","paid"]},"statusLabel":{"type":"string","minLength":1,"maxLength":200}},"required":["id","serviceNo","grower","serviceDate","time","crop","bushels","actual","services","status","statusLabel"],"additionalProperties":false}},"summary":{"type":"object","properties":{"openContracts":{"type":"integer","minimum":0,"maximum":9007199254740991},"openBu":{"type":"number","minimum":0,"maximum":100000000},"weekLoads":{"type":"integer","minimum":0,"maximum":9007199254740991},"weekBu":{"type":"number","minimum":0,"maximum":100000000},"activeOffers":{"type":"integer","minimum":0,"maximum":9007199254740991},"nearOffers":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextLoads":{"type":"integer","minimum":0,"maximum":9007199254740991},"recentTickets":{"type":"integer","minimum":0,"maximum":9007199254740991},"contractsCaption":{"type":"string","minLength":1,"maxLength":200},"contractsDescription":{"type":"string","minLength":1,"maxLength":200},"scheduleValue":{"type":"string","minLength":1,"maxLength":200},"scheduleCaption":{"type":"string","minLength":1,"maxLength":200},"offersCaption":{"type":"string","minLength":1,"maxLength":200},"deliveriesDescription":{"type":"string","minLength":1,"maxLength":200},"ticketsDescription":{"type":"string","minLength":1,"maxLength":200}},"required":["openContracts","openBu","weekLoads","weekBu","activeOffers","nearOffers","nextLoads","recentTickets","contractsCaption","contractsDescription","scheduleValue","scheduleCaption","offersCaption","deliveriesDescription","ticketsDescription"],"additionalProperties":false},"starts":{"type":"object","properties":{"scheduleDelivery":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"createTicket":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["scheduleDelivery","createTicket"],"additionalProperties":false}},"required":["contracts","loads","tickets","offers","services","summary","starts"],"additionalProperties":false}
grain.addBinBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
elevatorIdstring (uuid)required
labelstringrequired
crop"Corn" | "Soybeans" | "Wheat" | "Sorghum"required
gradestringmay be omitted
capacityBunumberrequired
dimsstringmay be omitted
openingBunumberrequired
5 schema notes
  • $.label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.grade refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.capacityBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.dims refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.openingBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1,"maxLength":200},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum"]},"grade":{"type":"string","minLength":1,"maxLength":200},"capacityBu":{"type":"number","minimum":0,"maximum":100000000},"dims":{"type":"string","minLength":1,"maxLength":200},"openingBu":{"type":"number","minimum":0,"maximum":100000000}},"required":["elevatorId","label","crop","capacityBu","openingBu"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"binId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["binId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false}},"required":["ok","error"],"additionalProperties":false}]}
grain.addBuyerBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
namestringrequired
buyerType"Processor" | "Ethanol" | "Feed mill" | "Exporter" | "Terminal"required
destinationstringrequired
paymentTermsstringmay be omitted
1 schema note
  • $.paymentTerms runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"buyerType":{"type":"string","enum":["Processor","Ethanol","Feed mill","Exporter","Terminal"]},"destination":{"type":"string","minLength":1,"maxLength":255},"paymentTerms":{"type":"string","minLength":1,"maxLength":255}},"required":["name","buyerType","destination"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"buyerCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["accountId","buyerCompanyId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["no_company"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.allocateTicketBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
ticketIdstring (uuid)required
allocationsarray of objectrequired
spotPriceUnitPricemay be omitted
3 schema notes
  • $.allocations refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.allocations[].bu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.spotPrice refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"allocations":{"type":"array","items":{"type":"object","properties":{"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"bu":{"type":"number","minimum":0,"maximum":100000000}},"required":["contractId","bu"]},"minItems":1,"maxItems":20},"spotPrice":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"}},"required":["ticketId","allocations"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["ticketId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_entered"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"contract_not_open"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"grower_mismatch"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"crop_mismatch"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"grade_mismatch"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"allocation_storage"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"allocation_over_room"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"allocation_over_load"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.applyTicketBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
ticketIdstring (uuid)required
contractIdstring (uuid)may be omitted
appliedBunumberrequired
1 schema note
  • $.appliedBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"appliedBu":{"type":"number","minimum":0,"maximum":100000000}},"required":["ticketId","appliedBu"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["ticketId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_entered"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"contract_not_open"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"grower_mismatch"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"crop_mismatch"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"grade_mismatch"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"allocation_storage"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"allocation_over_room"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"allocation_over_load"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.arriveBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
slotIdstring (uuid)required
arrivedAtstring (date-time)required
1 schema note
  • $.arrivedAt runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"slotId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"arrivedAt":{"type":"string","format":"date-time","x-zod-type":"date"}},"required":["slotId","arrivedAt"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"slotId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["slotId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_scheduled"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.basisAtRead grain basis at an elevator. UI supported

Input shape documented

FieldLogical typePresence
elevatorIdstring (uuid)required
crop"Corn" | "Soybeans" | "Wheat" | "Sorghum" | "Barley" | "Oats" | "Rye" | "Canola" | "Sunflower"required
futuresMonthstringrequired
1 schema note
  • $.futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"futuresMonth":{"type":"string","minLength":1,"maxLength":200}},"required":["elevatorId","crop","futuresMonth"]}

Output shape documented

FieldLogical typePresence
basisUnitPrice | nullrequired
1 schema note
  • $.basis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"basis":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]}},"required":["basis"],"additionalProperties":false}
grain.basisByLocationRead grain basis by location. UI supported

Input shape documented

FieldLogical typePresence
elevatorIdsarray of string (uuid)required
crop"Corn" | "Soybeans" | "Wheat" | "Sorghum" | "Barley" | "Oats" | "Rye" | "Canola" | "Sunflower"required
futuresMonthstringrequired
1 schema note
  • $.futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"elevatorIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"maxItems":250},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"futuresMonth":{"type":"string","minLength":1,"maxLength":200}},"required":["elevatorIds","crop","futuresMonth"]}

Output shape documented

FieldLogical typePresence
locationsarray of objectrequired
1 schema note
  • $.locations[].basis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"locations":{"type":"array","items":{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"basis":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]}},"required":["elevatorId","basis"],"additionalProperties":false}}},"required":["locations"],"additionalProperties":false}
grain.binCapacityBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
binIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"binId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["binId"]}

Output shape documented

FieldLogical typePresence
capacityobject | nullrequired
7 schema notes
  • $.capacity.capacityBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.capacity.onHandBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.capacity.headspaceBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.capacity.inboundBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.capacity.scheduled[].time refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.capacity.scheduled[].truck refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.capacity.scheduled[].loadBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"capacity":{"anyOf":[{"type":"object","properties":{"capacityBu":{"type":"number","minimum":0,"maximum":100000000},"onHandBu":{"type":"number","minimum":0,"maximum":100000000},"fillPct":{"type":"integer","minimum":0,"maximum":9007199254740991},"projectedPct":{"type":"integer","minimum":0,"maximum":9007199254740991},"fillBand":{"type":"string","enum":["atLine","high","normal"]},"fillStanding":{"type":"string","enum":["overLine","projectedOverLine","underLine"]},"headspaceBu":{"type":"number","minimum":0,"maximum":100000000},"inboundBu":{"type":"number","minimum":0,"maximum":100000000},"mix":{"anyOf":[{"type":"object","properties":{"originationPct":{"type":"integer","minimum":0,"maximum":100},"storagePct":{"type":"integer","minimum":0,"maximum":100}},"required":["originationPct","storagePct"],"additionalProperties":false},{"type":"null"}]},"scheduled":{"type":"array","items":{"type":"object","properties":{"slotId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"slotNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"deliveryDate":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"time":{"type":"string","minLength":1,"maxLength":200},"truck":{"type":"string","minLength":1,"maxLength":200},"loadBu":{"type":"number","minimum":0,"maximum":100000000}},"required":["slotId","slotNo","deliveryDate","time","truck","loadBu"],"additionalProperties":false}}},"required":["capacityBu","onHandBu","fillPct","projectedPct","fillBand","fillStanding","headspaceBu","inboundBu","mix","scheduled"],"additionalProperties":false},{"type":"null"}]}},"required":["capacity"],"additionalProperties":false}
grain.binPageBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
binIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"binId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["binId"]}

Output shape documented

FieldLogical typePresence
binobject | nullrequired
14 schema notes
  • $.bin.label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bin.cropShort refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bin.cropGrade refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bin.grade refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bin.dims refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bin.capacityBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bin.openingBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bin.onHandBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bin.elevator refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bin.gradeMoisture refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bin.gradeTestWeight refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bin.tickets[].netBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bin.tickets[].moisture refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bin.tickets[].testWeight refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"bin":{"anyOf":[{"type":"object","properties":{"binId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"binNo":{"type":"string","pattern":"^el-[a-z0-9-]+-b\\d+$"},"label":{"type":"string","minLength":1,"maxLength":200},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"cropShort":{"type":"string","minLength":1,"maxLength":200},"cropGrade":{"type":"string","minLength":1,"maxLength":200},"grade":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"dims":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"capacityBu":{"type":"number","minimum":0,"maximum":100000000},"openingBu":{"type":"number","minimum":0,"maximum":100000000},"onHandBu":{"type":"number","minimum":0,"maximum":100000000},"contents":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"elevator":{"type":"string","minLength":1,"maxLength":200},"verdicts":{"type":"object","properties":{"editBin":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["bin_removed"]}},"required":["status","error"],"additionalProperties":false}]},"removeBin":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["bin_removed"]}},"required":["status","error"],"additionalProperties":false}]},"moveGrain":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["bin_removed"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["editBin","removeBin","moveGrain"],"additionalProperties":false},"shipOut":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","const":"empty_bin"}},"required":["status","error"],"additionalProperties":false}]},"removal":{"type":"string","enum":["asksFirst","onePress"]},"gradeMoisture":{"anyOf":[{"type":"number","minimum":0,"maximum":100},{"type":"null"}]},"gradeTestWeight":{"anyOf":[{"type":"number","minimum":0,"maximum":80},{"type":"null"}]},"loads":{"type":"integer","minimum":0,"maximum":9007199254740991},"tickets":{"type":"array","items":{"type":"object","properties":{"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ticketNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"day":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"contractNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"netBu":{"type":"number","minimum":0,"maximum":100000000},"moisture":{"type":"number","minimum":0,"maximum":100},"testWeight":{"type":"number","minimum":0,"maximum":80}},"required":["ticketId","ticketNo","day","contractNo","netBu","moisture","testWeight"],"additionalProperties":false}}},"required":["binId","binNo","label","crop","cropShort","cropGrade","grade","dims","capacityBu","openingBu","onHandBu","contents","elevatorId","elevator","verdicts","shipOut","removal","gradeMoisture","gradeTestWeight","loads","tickets"],"additionalProperties":false},{"type":"null"}]}},"required":["bin"],"additionalProperties":false}
grain.binStockBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
Full logical schema
{"type":"object","properties":{}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
binCountintegerrequired
overLinearray of stringrequired
projectedOverLinearray of stringrequired
12 schema notes
  • $.rows[].grade refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].dims refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].cropGrade refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].capacityBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].openingBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].onHand refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].headspaceBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].inboundBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.overLine[] refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.projectedOverLine[] refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"binId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"grade":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"dims":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"verdicts":{"type":"object","properties":{"editBin":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["bin_removed"]}},"required":["status","error"],"additionalProperties":false}]},"removeBin":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["bin_removed"]}},"required":["status","error"],"additionalProperties":false}]},"moveGrain":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["bin_removed"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["editBin","removeBin","moveGrain"],"additionalProperties":false},"name":{"type":"string","minLength":1,"maxLength":200},"label":{"type":"string","minLength":1,"maxLength":200},"cropGrade":{"type":"string","minLength":1,"maxLength":200},"contents":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"capacityBu":{"type":"number","minimum":0,"maximum":100000000},"openingBu":{"type":"number","minimum":0,"maximum":100000000},"onHand":{"type":"number","minimum":0,"maximum":100000000},"headspaceBu":{"type":"number","minimum":0,"maximum":100000000},"inboundBu":{"type":"number","minimum":0,"maximum":100000000},"fillPct":{"type":"integer","minimum":0,"maximum":9007199254740991},"projectedPct":{"type":"integer","minimum":0,"maximum":9007199254740991},"fillBand":{"type":"string","enum":["atLine","high","normal"]},"fillStanding":{"type":"string","enum":["overLine","projectedOverLine","underLine"]},"moveGrain":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","const":"empty_bin"}},"required":["status","error"],"additionalProperties":false}]},"moveTo":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["binId","elevatorId","crop","grade","dims","verdicts","name","label","cropGrade","contents","capacityBu","openingBu","onHand","headspaceBu","inboundBu","fillPct","projectedPct","fillBand","fillStanding","moveGrain","moveTo"],"additionalProperties":false}},"binCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"overLine":{"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"projectedOverLine":{"type":"array","items":{"type":"string","minLength":1,"maxLength":200}}},"required":["rows","binCount","overLine","projectedOverLine"],"additionalProperties":false}
grain.bookAccumulatorBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
crop"Corn" | "Soybeans" | "Wheat"required
bushelsnumberrequired
accumulatorType"Weekly double up with knockout" | "Weekly accumulator" | "Daily double up with knockout" | "Daily accumulator"required
accumulationPriceUnitPricerequired
knockOutUnitPricerequired
perPeriodBunumberrequired
windowBeginCalendarDayrequired
windowEndCalendarDayrequired
futuresMonthstringrequired
elevatorIdstring (uuid)required
deliveryDateCalendarDayrequired
signedOnCalendarDaymay be omitted
issuedOnCalendarDaymay be omitted
commentstringmay be omitted
7 schema notes
  • $ refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.accumulationPrice refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.knockOut refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.perPeriodBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.comment runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat"]},"bushels":{"type":"number","minimum":0,"maximum":100000000},"accumulatorType":{"type":"string","enum":["Weekly double up with knockout","Weekly accumulator","Daily double up with knockout","Daily accumulator"]},"accumulationPrice":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"knockOut":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"perPeriodBu":{"type":"number","minimum":0,"maximum":100000000},"windowBegin":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"windowEnd":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"futuresMonth":{"type":"string","minLength":1,"maxLength":200},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"deliveryDate":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"signedOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"issuedOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"comment":{"type":"string","maxLength":5000}},"required":["accountId","crop","bushels","accumulatorType","accumulationPrice","knockOut","perPeriodBu","windowBegin","windowEnd","futuresMonth","elevatorId","deliveryDate"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"accumulatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["accumulatorId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"knock_out_not_below"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.buyOutContractBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
replacementPriceUnitPricerequired
buyoutFeePerBuUnitPricerequired
contractIdstring (uuid)required
2 schema notes
  • $.replacementPrice refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.buyoutFeePerBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"replacementPrice":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"buyoutFeePerBu":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["replacementPrice","buyoutFeePerBu","contractId"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["contractId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"contract_not_open"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"nothing_open"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.cancelContractBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
cancelReason"Grower request" | "Not signed in time" | "Entered in error"required
contractIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"cancelReason":{"type":"string","enum":["Grower request","Not signed in time","Entered in error"]},"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["cancelReason","contractId"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["contractId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"contract_not_open"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.cancelOfferBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
offerIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"offerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["offerId"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"offerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["offerId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"offer_expired"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"offer_not_open"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.contractPageBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
contractIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["contractId"]}

Output shape documented

FieldLogical typePresence
contractobject | nullrequired
49 schema notes
  • $.contract.grower refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.mode refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.statusLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.crop refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.grade refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.price refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.filledBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.openBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.elevator.name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.elevator.city refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.document|1.sentTo refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.document|2.sentTo refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.tickets[].truck refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.tickets[].netBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.tickets[].moisture refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.tickets[].settleBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.creditedBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.leftBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.payment.account refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.payment.paysBy refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.payment.terms refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.payment.liens refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.payment.activeHolders[] refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.payment.edit.paymentTerms refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.liens[].account refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.liens[].lienHolder refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.buyout.layers[].id refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.buyout.layers[].pricedBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.buyout.layers[].futures refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.buyout.layers[].basis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.buyout.layers[].price refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.buyout.layers[].pricedOn refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.changes.pricedSoFarBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.changes.freight.perBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.changes.rollCarry.carry refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.changes.rollCarry.futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.history[]|0.when refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.history[]|1.when refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.history[]|2.when refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.history[]|4.when refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.onContract[].truck refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.onContract[].netBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.onContract[].moisture refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.onContract[].settleBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.available[].netBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.available[].settleBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.available[].grower refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contract.available[].grade refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"contract":{"anyOf":[{"type":"object","properties":{"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"growerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"grower":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"openGrower":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]},"dealType":{"type":"string","enum":["origination","direct-ship","storage / DP"]},"mode":{"type":"string","minLength":1,"maxLength":200},"status":{"type":"string","enum":["awaiting-sig","signed","active","expired","filled","stored","cancelled","bought out"]},"statusLabel":{"type":"string","minLength":1,"maxLength":200},"crop":{"type":"string","minLength":1,"maxLength":200},"commodity":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"grade":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"price":{"type":"string","minLength":1,"maxLength":200},"bushels":{"type":"number","minimum":0,"maximum":100000000},"targetStart":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"targetEnd":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"signingDeadlineAt":{"type":"string","format":"date-time","x-zod-type":"date"},"filledBu":{"type":"number","minimum":0,"maximum":100000000},"openBu":{"type":"number","minimum":0,"maximum":100000000},"fillPct":{"type":"integer","minimum":0,"maximum":9007199254740991},"elevator":{"anyOf":[{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":200},"city":{"type":"string","minLength":1,"maxLength":200},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]}},"required":["elevatorId","name","city","state"],"additionalProperties":false},{"type":"null"}]},"signed":{"type":"boolean"},"applyPrompt":{"type":"boolean"},"document":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"signed"},"signedOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","signedOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"sent"},"sentTo":{"type":"string","minLength":1,"maxLength":200},"sentOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","sentTo","sentOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"failed"},"envelopeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sentTo":{"type":"string","minLength":1,"maxLength":200},"sentOn":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string","enum":["no_email","rejected","unauthorized","unresolved","record_closed"]},{"type":"string","enum":["rejected","unauthorized","unresolved","missing_document","record_closed"]},{"type":"string","enum":["declined","expired"]}]},"retryAvailable":{"type":"boolean"}},"required":["kind","envelopeId","sentTo","sentOn","reason","retryAvailable"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"notSent"}},"required":["kind"],"additionalProperties":false}]},"tickets":{"type":"array","items":{"type":"object","properties":{"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ticketNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"day":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"truck":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"netBu":{"type":"number","minimum":0,"maximum":100000000},"moisture":{"type":"number","minimum":0,"maximum":100},"moistureHigh":{"type":"boolean"},"settleBu":{"type":"number","minimum":0,"maximum":100000000},"status":{"type":"string","enum":["entered","applied","in settlement","settled"]},"alertLevel":{"type":"integer","minimum":0,"maximum":2},"alert":{"anyOf":[{"type":"string","enum":["off-grade","rejected"]},{"type":"null"}]},"verdicts":{"type":"object","properties":{"apply":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"queue":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"unapply":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["apply","queue","unapply"],"additionalProperties":false}},"required":["ticketId","ticketNo","day","truck","netBu","moisture","moistureHigh","settleBu","status","alertLevel","alert","verdicts"],"additionalProperties":false}},"ticketCounts":{"type":"object","properties":{"tickets":{"type":"integer","minimum":0,"maximum":9007199254740991},"waiting":{"type":"integer","minimum":0,"maximum":9007199254740991},"applied":{"type":"integer","minimum":0,"maximum":9007199254740991},"settled":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["tickets","waiting","applied","settled"],"additionalProperties":false},"creditedBu":{"type":"number","minimum":0,"maximum":100000000},"leftBu":{"type":"number","minimum":0,"maximum":100000000},"payment":{"anyOf":[{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"account":{"type":"string","minLength":1,"maxLength":200},"paysBy":{"type":"string","minLength":1,"maxLength":200},"terms":{"type":"string","minLength":1,"maxLength":200},"liens":{"type":"string","minLength":1,"maxLength":200},"activeHolders":{"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"edit":{"type":"object","properties":{"verdict":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]},"payMethod":{"type":"string","enum":["ACH","Check"]},"paymentTerms":{"type":"string","minLength":1,"maxLength":200}},"required":["verdict","payMethod","paymentTerms"],"additionalProperties":false}},"required":["accountId","account","paysBy","terms","liens","activeHolders","edit"],"additionalProperties":false},{"type":"null"}]},"liens":{"type":"array","items":{"type":"object","properties":{"lienId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lienNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"account":{"type":"string","minLength":1,"maxLength":200},"lienHolder":{"type":"string","minLength":1,"maxLength":200},"lienKind":{"type":"string","enum":["UCC-1 crop lien","CCC marketing loan"]},"lienAmount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"filedOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"status":{"type":"string","enum":["active","released"]},"releasedOn":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"verdicts":{"type":"object","properties":{"release":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]}},"required":["release"],"additionalProperties":false}},"required":["lienId","lienNo","accountId","account","lienHolder","lienKind","lienAmount","filedOn","status","releasedOn","verdicts"],"additionalProperties":false}},"recordLien":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]},"send":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","const":"already_sent"}},"required":["status","error"],"additionalProperties":false}]},"retry":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["other_preparation","other_document","not_retryable","record_closed","not_unresolved","not_completable","not_failed"]}},"required":["status","error"],"additionalProperties":false}]},"schedule":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","const":"contract_not_open"}},"required":["status","error"],"additionalProperties":false}]},"verdicts":{"type":"object","properties":{"cancelContract":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["not_awaiting_sig","contract_not_open","no_futures_month","over_contract","fully_priced","priced_before_signed","nothing_open"]}},"required":["status","error"],"additionalProperties":false}]},"buyOutContract":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["not_awaiting_sig","contract_not_open","no_futures_month","over_contract","fully_priced","priced_before_signed","nothing_open"]}},"required":["status","error"],"additionalProperties":false}]},"setFreightTerms":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["not_awaiting_sig","contract_not_open","no_futures_month","over_contract","fully_priced","priced_before_signed","nothing_open"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["cancelContract","buyOutContract","setFreightTerms"],"additionalProperties":false},"buyout":{"type":"object","properties":{"layers":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string","enum":["birth","pricing"]},"id":{"type":"string","minLength":1,"maxLength":200},"pricedBu":{"type":"number","minimum":0,"maximum":100000000},"futures":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"basis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"price":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"recordedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"pricedOn":{"type":"string","minLength":1,"maxLength":200}},"required":["source","id","pricedBu","futures","basis","price","recordedAt","pricedOn"],"additionalProperties":false}}},"required":["layers"],"additionalProperties":false},"today":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"changes":{"type":"object","properties":{"pricedSoFarBu":{"anyOf":[{"type":"number","minimum":0,"maximum":100000000},{"type":"null"}]},"advancesDrawn":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"freight":{"anyOf":[{"type":"object","properties":{"perBu":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"paidBy":{"type":"string","enum":["Elevator","Grower"]}},"required":["perBu","paidBy"],"additionalProperties":false},{"type":"null"}]},"rollCarry":{"anyOf":[{"type":"object","properties":{"carry":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"futuresMonth":{"type":"string","minLength":1,"maxLength":200}},"required":["carry","futuresMonth"],"additionalProperties":false},{"type":"null"}]}},"required":["pricedSoFarBu","advancesDrawn","freight","rollCarry"],"additionalProperties":false},"history":{"anyOf":[{"type":"array","items":{"oneOf":[{"type":"object","properties":{"event":{"type":"string","const":"targetHit"},"when":{"type":"string","minLength":1,"maxLength":200}},"required":["event","when"],"additionalProperties":false},{"type":"object","properties":{"event":{"type":"string","const":"sent"},"when":{"type":"string","minLength":1,"maxLength":200},"atTrigger":{"type":"boolean"}},"required":["event","when","atTrigger"],"additionalProperties":false},{"type":"object","properties":{"event":{"type":"string","const":"generated"},"when":{"type":"string","minLength":1,"maxLength":200},"atTrigger":{"type":"boolean"}},"required":["event","when","atTrigger"],"additionalProperties":false},{"type":"object","properties":{"event":{"type":"string","const":"signed"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["event","on"],"additionalProperties":false},{"type":"object","properties":{"event":{"type":"string","const":"awaitingSignature"},"when":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},"required":["event","when"],"additionalProperties":false}]}},{"type":"null"}]},"onContract":{"type":"array","items":{"type":"object","properties":{"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ticketNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"day":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"truck":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"netBu":{"type":"number","minimum":0,"maximum":100000000},"moisture":{"type":"number","minimum":0,"maximum":100},"moistureHigh":{"type":"boolean"},"settleBu":{"type":"number","minimum":0,"maximum":100000000},"status":{"type":"string","enum":["entered","applied","in settlement","settled"]},"alertLevel":{"type":"integer","minimum":0,"maximum":2},"alert":{"anyOf":[{"type":"string","enum":["off-grade","rejected"]},{"type":"null"}]},"verdicts":{"type":"object","properties":{"apply":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"queue":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"unapply":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["apply","queue","unapply"],"additionalProperties":false}},"required":["ticketId","ticketNo","day","truck","netBu","moisture","moistureHigh","settleBu","status","alertLevel","alert","verdicts"],"additionalProperties":false}},"available":{"type":"array","items":{"type":"object","properties":{"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ticketNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"day":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"netBu":{"type":"number","minimum":0,"maximum":100000000},"settleBu":{"type":"number","minimum":0,"maximum":100000000},"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"growerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"grower":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"grade":{"type":"string","minLength":1,"maxLength":200},"verdicts":{"type":"object","properties":{"apply":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["apply"],"additionalProperties":false}},"required":["ticketId","ticketNo","day","netBu","settleBu","contractId","contractNo","growerId","grower","crop","grade","verdicts"],"additionalProperties":false}}},"required":["contractId","contractNo","growerId","grower","openGrower","dealType","mode","status","statusLabel","crop","commodity","grade","price","bushels","filledBu","openBu","fillPct","elevator","signed","applyPrompt","document","tickets","ticketCounts","creditedBu","leftBu","payment","liens","recordLien","send","retry","schedule","verdicts","buyout","today","changes","history","onContract","available"],"additionalProperties":false},{"type":"null"}]}},"required":["contract"],"additionalProperties":false}
grain.contractsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
limitintegermay be omitted
cursorstring | nullmay be omitted
status"all" | "active" | "signed" | "awaiting-sig" | "stored"may be omitted
sort"newest"may be omitted
5 schema notes
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.status runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sort runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":200},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"status":{"type":"string","enum":["all","active","signed","awaiting-sig","stored"]},"sort":{"type":"string","const":"newest"}}}

Output shape documented

FieldLogical typePresence
rowsarray of object | objectrequired
totalintegerrequired
nextCursorstring | nullrequired
facetsobjectrequired
totalsobjectrequired
17 schema notes
  • $.rows[]|0.party refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.mode refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.crop refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.grade refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.price refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.filledBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.statusLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.party refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.mode refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.crop refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.grade refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.price refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.filledBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.statusLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.totals.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"purchase"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"party":{"type":"string","minLength":1,"maxLength":200},"dealType":{"type":"string","enum":["origination","direct-ship","storage / DP"]},"mode":{"type":"string","minLength":1,"maxLength":200},"crop":{"type":"string","minLength":1,"maxLength":200},"grade":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"price":{"type":"string","minLength":1,"maxLength":200},"bushels":{"type":"number","minimum":0,"maximum":100000000},"filledBu":{"type":"number","minimum":0,"maximum":100000000},"status":{"type":"string","enum":["awaiting-sig","signed","active","expired","filled","stored","cancelled","bought out"]},"statusLabel":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","id","contractNo","party","dealType","mode","crop","grade","price","bushels","filledBu","status","statusLabel"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"sale"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"party":{"type":"string","minLength":1,"maxLength":200},"dealType":{"type":"string","enum":["origination","direct-ship","storage / DP"]},"mode":{"type":"string","minLength":1,"maxLength":200},"crop":{"type":"string","minLength":1,"maxLength":200},"grade":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"price":{"type":"string","minLength":1,"maxLength":200},"bushels":{"type":"number","minimum":0,"maximum":100000000},"filledBu":{"type":"number","minimum":0,"maximum":100000000},"status":{"type":"string","enum":["awaiting-sig","signed","active","expired","filled","stored","cancelled","bought out"]},"statusLabel":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","id","contractNo","party","dealType","mode","crop","grade","price","bushels","filledBu","status","statusLabel"],"additionalProperties":false}]}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"facets":{"type":"object","properties":{"all":{"type":"integer","minimum":0,"maximum":9007199254740991},"active":{"type":"integer","minimum":0,"maximum":9007199254740991},"signed":{"type":"integer","minimum":0,"maximum":9007199254740991},"awaitingSig":{"type":"integer","minimum":0,"maximum":9007199254740991},"stored":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["all","active","signed","awaitingSig","stored"],"additionalProperties":false},"totals":{"type":"object","properties":{"contracts":{"type":"integer","minimum":0,"maximum":9007199254740991},"bushels":{"type":"number","minimum":0,"maximum":100000000}},"required":["contracts","bushels"],"additionalProperties":false}},"required":["rows","total","nextCursor","facets","totals"],"additionalProperties":false}
grain.createContractBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
growerIdstring (uuid)required
dealType"origination" | "direct-ship" | "storage / DP"required
crop"Corn" | "Soybeans" | "Wheat" | "Sorghum" | "Barley" | "Oats" | "Rye" | "Canola" | "Sunflower"required
cropClassstringmay be omitted
gradeCommittedstringmay be omitted
bushelsnumberrequired
elevatorIdstring (uuid)required
priceMode"price now" | "set target"required
contractType"full priced" | "futures only" | "basis only" | "delayed price"required
premiumsPickedarray of objectmay be omitted
futuresMonthstringmay be omitted
dpBasisUnitPricemay be omitted
deliveryMonthstringmay be omitted
targetStartCalendarDaymay be omitted
targetEndCalendarDaymay be omitted
counterpartiesarray of objectmay be omitted
12 schema notes
  • $.cropClass refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.gradeCommitted refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.premiumsPicked[].premium refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.premiumsPicked[].amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.premiumsPicked runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.dpBasis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.deliveryMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.counterparties refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.counterparties[].sharePct refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.counterparties runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"growerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dealType":{"type":"string","enum":["origination","direct-ship","storage / DP"]},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"cropClass":{"type":"string","minLength":1,"maxLength":200},"gradeCommitted":{"type":"string","minLength":1,"maxLength":200},"bushels":{"type":"number","minimum":0,"maximum":10000000},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priceMode":{"type":"string","enum":["price now","set target"]},"contractType":{"type":"string","enum":["full priced","futures only","basis only","delayed price"]},"premiumsPicked":{"type":"array","items":{"type":"object","properties":{"premium":{"type":"string","minLength":1,"maxLength":200},"amount":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"}},"required":["premium","amount"]}},"futuresMonth":{"type":"string","minLength":1,"maxLength":200},"dpBasis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"deliveryMonth":{"type":"string","minLength":1,"maxLength":200},"targetStart":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"targetEnd":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"counterparties":{"type":"array","items":{"type":"object","properties":{"account":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sharePct":{"type":"number","minimum":0,"maximum":100}},"required":["account","sharePct"]}}},"required":["growerId","dealType","crop","bushels","elevatorId","priceMode","contractType"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["contractId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_price_now"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.createContractAvailabilityBusiness procedure UI supported

Input

No input schema declared; no input shape inferred.

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]}
grain.createOfferBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
crop"Corn" | "Soybeans" | "Wheat" | "Sorghum" | "Barley" | "Oats" | "Rye" | "Canola" | "Sunflower"required
offerBunumberrequired
futuresMonthstringrequired
elevatorIdstring (uuid)required
duration"GTC" | "Day"required
expirationCalendarDaymay be omitted
armobject | object | object | objectrequired
accountSplit"Operating account" | "Landlord split account" | "Trust account"may be omitted
deliveryStartCalendarDaymay be omitted
deliveryEndCalendarDaymay be omitted
receivedVia"Phone" | "Text" | "Email" | "In person"may be omitted
commentstringmay be omitted
8 schema notes
  • $ refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offerBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.arm|0.targetPrice refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.arm|1.targetPrice refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.arm|2.targetPrice refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.arm|3.basisTarget refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.comment runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"offerBu":{"type":"number","minimum":0,"maximum":100000000},"futuresMonth":{"type":"string","minLength":1,"maxLength":200},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"duration":{"type":"string","enum":["GTC","Day"]},"expiration":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"arm":{"oneOf":[{"type":"object","properties":{"offerType":{"type":"string","const":"Cash"},"targetPrice":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"}},"required":["offerType","targetPrice"],"additionalProperties":false},{"type":"object","properties":{"offerType":{"type":"string","const":"Flat"},"targetPrice":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"}},"required":["offerType","targetPrice"],"additionalProperties":false},{"type":"object","properties":{"offerType":{"type":"string","const":"HTA"},"targetPrice":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"}},"required":["offerType","targetPrice"],"additionalProperties":false},{"type":"object","properties":{"offerType":{"type":"string","const":"Basis"},"basisTarget":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"}},"required":["offerType","basisTarget"],"additionalProperties":false}]},"accountSplit":{"type":"string","enum":["Operating account","Landlord split account","Trust account"]},"deliveryStart":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"deliveryEnd":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"receivedVia":{"type":"string","enum":["Phone","Text","Email","In person"]},"comment":{"type":"string","maxLength":5000}},"required":["accountId","crop","offerBu","futuresMonth","elevatorId","duration","arm"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"offerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["offerId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"target_not_positive"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.createServiceInvoiceBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
serviceIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"serviceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["serviceId"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"serviceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"exportId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["serviceId","exportId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_serviced"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.deliveryScheduleBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
limitintegermay be omitted
cursorstring | nullmay be omitted
sort"day"may be omitted
4 schema notes
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sort runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":200},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"sort":{"type":"string","const":"day"}}}

Output shape documented

FieldLogical typePresence
rowsarray of object | objectrequired
totalintegerrequired
nextCursorstring | nullrequired
facetsobjectrequired
totalsobjectrequired
36 schema notes
  • $.rows[]|0.time refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.truck refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.loadBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.netBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.settleBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.overageBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.appliedBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.alertReason refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.ticketReadings.grossLb refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.ticketReadings.tareLb refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.ticketReadings.moisture refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.ticketReadings.testWeight refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.cropShort refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.grower refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.split refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.location refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.binCropShort refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.binMismatch.binLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.binMismatch.binHolds refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.openBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.contractPrice refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.parties[].name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.parties[].sharePct refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.spotPrice refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.time refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.truck refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.loadBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.grower refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.location refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.note refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.totals.todayBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.totals.openBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.totals.weekBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.totals.days[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.totals.days[].caption refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.totals.days[].bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"slotId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"slotNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"status":{"type":"string","enum":["scheduled","on scale","received"]},"deliveryDate":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"time":{"type":"string","minLength":1,"maxLength":200},"truck":{"type":"string","minLength":1,"maxLength":200},"loadBu":{"type":"number","minimum":0,"maximum":100000000},"ticketId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"ticketNo":{"anyOf":[{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},{"type":"null"}]},"ticketStatus":{"anyOf":[{"type":"string","enum":["entered","applied","settlement","settled","deliverySettled"]},{"type":"null"}]},"netBu":{"anyOf":[{"type":"number","minimum":0,"maximum":100000000},{"type":"null"}]},"settleBu":{"anyOf":[{"type":"number","minimum":0,"maximum":100000000},{"type":"null"}]},"overageBu":{"anyOf":[{"type":"number","minimum":0,"maximum":100000000},{"type":"null"}]},"appliedBu":{"anyOf":[{"type":"number","minimum":0,"maximum":100000000},{"type":"null"}]},"alertLevel":{"anyOf":[{"type":"integer","minimum":0,"maximum":2},{"type":"null"}]},"alertReason":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"ticketReadings":{"anyOf":[{"type":"object","properties":{"grossLb":{"type":"number","minimum":0,"maximum":200000},"tareLb":{"type":"number","minimum":0,"maximum":200000},"moisture":{"type":"number","minimum":0,"maximum":100},"testWeight":{"type":"number","minimum":0,"maximum":80}},"required":["grossLb","tareLb","moisture","testWeight"],"additionalProperties":false},{"type":"null"}]},"verdicts":{"type":"object","properties":{"truckOnScale":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]},"weighIn":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","const":"slot_received"}},"required":["status","error"],"additionalProperties":false}]},"applyTicket":{"anyOf":[{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},{"type":"null"}]},"viewTicket":{"anyOf":[{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]},{"type":"null"}]}},"required":["truckOnScale","weighIn","applyTicket","viewTicket"],"additionalProperties":false},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"cropShort":{"type":"string","minLength":1,"maxLength":200},"grower":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"dealType":{"type":"string","enum":["origination","direct-ship","storage / DP"]},"split":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"location":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"binCropShort":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"binFillPct":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"binMismatch":{"anyOf":[{"type":"object","properties":{"binLabel":{"type":"string","minLength":1,"maxLength":200},"binHolds":{"type":"string","minLength":1,"maxLength":200}},"required":["binLabel","binHolds"],"additionalProperties":false},{"type":"null"}]},"binId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"now":{"type":"boolean"},"dayPlace":{"type":"integer","minimum":0,"maximum":9007199254740991},"openBu":{"type":"number","minimum":0,"maximum":100000000},"contractPrice":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"parties":{"type":"array","items":{"type":"object","properties":{"account":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"sharePct":{"type":"number","minimum":0,"maximum":100}},"required":["account","name","sharePct"],"additionalProperties":false}},"spotPrice":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"kind":{"type":"string","const":"load"}},"required":["slotId","slotNo","status","deliveryDate","time","truck","loadBu","ticketId","ticketNo","ticketStatus","netBu","settleBu","overageBu","appliedBu","alertLevel","alertReason","ticketReadings","verdicts","id","contractId","contractNo","crop","cropShort","grower","dealType","split","location","binCropShort","binFillPct","binMismatch","binId","now","dayPlace","openBu","contractPrice","parties","spotPrice","kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"service"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"serviceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"serviceNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"deliveryDate":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"time":{"type":"string","minLength":1,"maxLength":200},"truck":{"type":"string","minLength":1,"maxLength":200},"loadBu":{"type":"number","minimum":0,"maximum":100000000},"status":{"type":"string","enum":["scheduled","on scale","received"]},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"grower":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"location":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"note":{"type":"string","minLength":1,"maxLength":200},"actionLabel":{"type":"string","enum":["Record service","Invoice","View order"]},"now":{"type":"boolean","const":false},"dayPlace":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["kind","id","serviceId","serviceNo","deliveryDate","time","truck","loadBu","status","crop","grower","location","note","actionLabel","now","dayPlace"],"additionalProperties":false}]}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"facets":{"type":"object","properties":{},"additionalProperties":false},"totals":{"type":"object","properties":{"todayLoads":{"type":"integer","minimum":0,"maximum":9007199254740991},"todayBu":{"type":"number","minimum":0,"maximum":100000000},"doneToday":{"type":"integer","minimum":0,"maximum":9007199254740991},"onSite":{"type":"integer","minimum":0,"maximum":9007199254740991},"toCome":{"type":"integer","minimum":0,"maximum":9007199254740991},"openLoads":{"type":"integer","minimum":0,"maximum":9007199254740991},"openBu":{"type":"number","minimum":0,"maximum":100000000},"weekLoads":{"type":"integer","minimum":0,"maximum":9007199254740991},"weekBu":{"type":"number","minimum":0,"maximum":100000000},"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"label":{"type":"string","minLength":1,"maxLength":200},"caption":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"loads":{"type":"integer","minimum":0,"maximum":9007199254740991},"bushels":{"type":"number","minimum":0,"maximum":100000000}},"required":["day","label","caption","loads","bushels"],"additionalProperties":false}}},"required":["todayLoads","todayBu","doneToday","onSite","toCome","openLoads","openBu","weekLoads","weekBu","days"],"additionalProperties":false}},"required":["rows","total","nextCursor","facets","totals"],"additionalProperties":false}
grain.draftServiceBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
elevatorIdstring (uuid)required
crop"Corn" | "Soybeans" | "Wheat" | "Sorghum"required
estBushelsnumberrequired
estMoisturenumberrequired
dryTonumberrequired
servicesarray of "Drying" | "Receiving & handling" | "Cleaning" | "Storage" | "Load-out"required
storageMonthsintegerrequired
customLinesarray of object | objectrequired
agreementNotestringmay be omitted
8 schema notes
  • $.estBushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.estMoisture refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.dryTo refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.customLines[]|0.label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.customLines[]|0.rate refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.customLines[]|1.label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.customLines[]|1.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.agreementNote refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum"]},"estBushels":{"type":"number","minimum":0,"maximum":1000000},"estMoisture":{"type":"number","minimum":0,"maximum":100},"dryTo":{"type":"number","minimum":0,"maximum":100},"services":{"type":"array","items":{"type":"string","enum":["Drying","Receiving & handling","Cleaning","Storage","Load-out"]}},"storageMonths":{"type":"integer","minimum":0,"maximum":24},"customLines":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"unit":{"type":"string","const":"perBushel"},"label":{"type":"string","minLength":1,"maxLength":200},"rate":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"}},"required":["unit","label","rate"]},{"type":"object","properties":{"unit":{"type":"string","const":"flat"},"label":{"type":"string","minLength":1,"maxLength":200},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["unit","label","amount"]}]}},"agreementNote":{"type":"string","minLength":1,"maxLength":200}},"required":["accountId","elevatorId","crop","estBushels","estMoisture","dryTo","services","storageMonths","customLines"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"serviceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["serviceId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_service"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.editBinBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
binIdstring (uuid)required
labelstringrequired
capacityBunumberrequired
gradestringmay be omitted
dimsstringmay be omitted
4 schema notes
  • $.label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.capacityBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.grade refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.dims refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"binId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1,"maxLength":200},"capacityBu":{"type":"number","minimum":0,"maximum":100000000},"grade":{"type":"string","minLength":1,"maxLength":200},"dims":{"type":"string","minLength":1,"maxLength":200}},"required":["binId","label","capacityBu"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"binId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["binId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_active"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.editElevatorBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
elevatorIdstring (uuid)required
namestringrequired
regionstringrequired
citystringrequired
state"AL" | "AK" | "AZ" | "AR" | "CA" | "CO" | "CT" | "DE" | "DC" | "FL" | "GA" | "HI" | "ID" | "IL" | "IN" | "IA" | "KS" | "KY" | "LA" | "ME" | "MD" | "MA" | "MI" | "MN" | "MS" | "MO" | "MT" | "NE" | "NV" | "NH" | "NJ" | "NM" | "NY" | "NC" | "ND" | "OH" | "OK" | "OR" | "PA" | "RI" | "SC" | "SD" | "TN" | "TX" | "UT" | "VT" | "VA" | "WA" | "WV" | "WI" | "WY"required
capacityBunumberrequired
railServed"yes" | "no"required
4 schema notes
  • $.name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.region refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.city refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.capacityBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":200},"region":{"type":"string","minLength":1,"maxLength":200},"city":{"type":"string","minLength":1,"maxLength":200},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"capacityBu":{"type":"number","minimum":0,"maximum":100000000},"railServed":{"type":"string","enum":["yes","no"]}},"required":["elevatorId","name","region","city","state","capacityBu","railServed"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["elevatorId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_elevator"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.elevatorCashBidRead elevator cash bids. UI supported

Input shape documented

FieldLogical typePresence
elevatorIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["elevatorId"]}

Output shape documented

FieldLogical typePresence
bidsarray of object | nullrequired
4 schema notes
  • $.bids[].futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bids[].boardLast refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bids[].basis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bids[].bid refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"bids":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"futuresMonth":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"boardLast":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"basis":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"bid":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]}},"required":["crop","futuresMonth","boardLast","basis","bid"],"additionalProperties":false}},{"type":"null"}]}},"required":["bids"],"additionalProperties":false}
grain.elevatorContractsRead an elevator’s grain contracts. UI supported

Input shape documented

FieldLogical typePresence
elevatorIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["elevatorId"]}

Output shape documented

FieldLogical typePresence
contractsarray of object | nullrequired
2 schema notes
  • $.contracts[].cropGrade refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contracts[].bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"contracts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"dealType":{"type":"string","enum":["origination","direct-ship","storage / DP"]},"cropGrade":{"type":"string","minLength":1,"maxLength":200},"bushels":{"type":"number","minimum":0,"maximum":100000000}},"required":["contractId","contractNo","dealType","cropGrade","bushels"],"additionalProperties":false}},{"type":"null"}]}},"required":["contracts"],"additionalProperties":false}
grain.elevatorPageBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
elevatorIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["elevatorId"]}

Output shape documented

FieldLogical typePresence
elevatorobject | nullrequired
15 schema notes
  • $.elevator.name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.elevator.region refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.elevator.city refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.elevator.capacityBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.elevator.storedBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.elevator.bins[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.elevator.bins[].cropGrade refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.elevator.bins[].grade refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.elevator.bins[].dims refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.elevator.bins[].capacityBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.elevator.bins[].onHandBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.elevator.bins[].headspaceBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.elevator.bins[].inboundBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.elevator.overLine[] refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.elevator.projectedOverLine[] refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"elevator":{"anyOf":[{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"elevatorNo":{"type":"string","pattern":"^el-(?!.*-b\\d+$)[a-z0-9]+(-[a-z0-9]+)*$"},"name":{"type":"string","minLength":1,"maxLength":200},"region":{"type":"string","minLength":1,"maxLength":200},"city":{"type":"string","minLength":1,"maxLength":200},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"capacityBu":{"type":"number","minimum":0,"maximum":100000000},"storedBu":{"type":"number","minimum":0,"maximum":100000000},"utilizationPct":{"type":"integer","minimum":0,"maximum":9007199254740991},"utilizationBand":{"type":"string","enum":["atLine","high","normal"]},"railServed":{"type":"string","enum":["yes","no"]},"shipping":{"type":"string","enum":["Truck + rail","Truck only"]},"pits":{"type":"integer","minimum":0,"maximum":24},"crops":{"type":"array","items":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]}},"bins":{"type":"array","items":{"type":"object","properties":{"binId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1,"maxLength":200},"cropGrade":{"type":"string","minLength":1,"maxLength":200},"grade":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"dims":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"capacityBu":{"type":"number","minimum":0,"maximum":100000000},"onHandBu":{"type":"number","minimum":0,"maximum":100000000},"headspaceBu":{"type":"number","minimum":0,"maximum":100000000},"inboundBu":{"type":"number","minimum":0,"maximum":100000000},"fillPct":{"type":"integer","minimum":0,"maximum":9007199254740991},"projectedPct":{"type":"integer","minimum":0,"maximum":9007199254740991},"fillBand":{"type":"string","enum":["atLine","high","normal"]},"fillStanding":{"type":"string","enum":["overLine","projectedOverLine","underLine"]},"verdicts":{"type":"object","properties":{"editBin":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["bin_removed"]}},"required":["status","error"],"additionalProperties":false}]},"removeBin":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["bin_removed"]}},"required":["status","error"],"additionalProperties":false}]},"moveGrain":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["bin_removed"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["editBin","removeBin","moveGrain"],"additionalProperties":false},"removal":{"type":"string","enum":["asksFirst","onePress"]}},"required":["binId","label","cropGrade","grade","dims","capacityBu","onHandBu","headspaceBu","inboundBu","fillPct","projectedPct","fillBand","fillStanding","verdicts","removal"],"additionalProperties":false}},"overLine":{"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"projectedOverLine":{"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"addBin":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]}},"required":["elevatorId","elevatorNo","name","region","city","state","capacityBu","storedBu","utilizationPct","utilizationBand","railServed","shipping","pits","crops","bins","overLine","projectedOverLine","addBin"],"additionalProperties":false},{"type":"null"}]}},"required":["elevator"],"additionalProperties":false}
grain.elevatorsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
Full logical schema
{"type":"object","properties":{}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
binsarray of objectrequired
sitesarray of object | objectrequired
setUpElevatorobject | objectrequired
22 schema notes
  • $.rows[].name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].region refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].city refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].capacityBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].storedBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bins[].elevator refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bins[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bins[].grade refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bins[].capacityBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bins[].dims refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bins[].openingBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bins[].onHand refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sites[]|0.name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sites[]|0.city refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sites[]|0.lat refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sites[]|0.lng refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sites[]|0.hours refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sites[]|1.name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sites[]|1.city refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sites[]|1.lat refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sites[]|1.lng refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sites[]|1.hours refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"elevatorNo":{"type":"string","pattern":"^el-(?!.*-b\\d+$)[a-z0-9]+(-[a-z0-9]+)*$"},"name":{"type":"string","minLength":1,"maxLength":200},"region":{"type":"string","minLength":1,"maxLength":200},"city":{"type":"string","minLength":1,"maxLength":200},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"capacityBu":{"type":"number","minimum":0,"maximum":100000000},"railServed":{"type":"string","enum":["yes","no"]},"pits":{"type":"integer","minimum":0,"maximum":24},"storedBu":{"type":"number","minimum":0,"maximum":100000000},"utilizationPct":{"type":"integer","minimum":0,"maximum":9007199254740991},"utilizationBand":{"type":"string","enum":["atLine","high","normal"]},"crops":{"type":"array","items":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]}},"addBin":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]},"verdicts":{"type":"object","properties":{"editElevator":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["bins_hold_grain","open_commitments"]}},"required":["status","error"],"additionalProperties":false}]},"retireElevator":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["bins_hold_grain","open_commitments"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["editElevator","retireElevator"],"additionalProperties":false}},"required":["elevatorId","elevatorNo","name","region","city","state","capacityBu","railServed","pits","storedBu","utilizationPct","utilizationBand","crops","addBin","verdicts"],"additionalProperties":false}},"bins":{"type":"array","items":{"type":"object","properties":{"binId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"elevator":{"type":"string","minLength":1,"maxLength":200},"binNo":{"type":"string","pattern":"^el-[a-z0-9-]+-b\\d+$"},"label":{"type":"string","minLength":1,"maxLength":200},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"grade":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"capacityBu":{"type":"number","minimum":0,"maximum":100000000},"dims":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"openingBu":{"type":"number","minimum":0,"maximum":100000000},"onHand":{"type":"number","minimum":0,"maximum":100000000},"verdicts":{"type":"object","properties":{"editBin":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["bin_removed"]}},"required":["status","error"],"additionalProperties":false}]},"removeBin":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["bin_removed"]}},"required":["status","error"],"additionalProperties":false}]},"moveGrain":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["bin_removed"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["editBin","removeBin","moveGrain"],"additionalProperties":false}},"required":["binId","elevatorId","elevator","binNo","label","crop","grade","capacityBu","dims","openingBu","onHand","verdicts"],"additionalProperties":false}},"sites":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"operated"},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":200},"city":{"type":"string","minLength":1,"maxLength":200},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"address":{"type":"string","minLength":1,"maxLength":472},"lat":{"type":"number","minimum":-90,"maximum":90},"lng":{"type":"number","minimum":-180,"maximum":180},"phone":{"anyOf":[{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},{"type":"null"}]},"hours":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"seasonal":{"type":"string","enum":["yes","no"]},"services":{"type":"array","items":{"anyOf":[{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},{"type":"string","enum":["Grain","Crop Protection","Liquid Fert","Seed","Rail"]}]},"maxItems":14}},"required":["kind","elevatorId","name","city","state","address","lat","lng","phone","hours","seasonal","services"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"network"},"locationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":200},"city":{"type":"string","minLength":1,"maxLength":200},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"address":{"type":"string","minLength":1,"maxLength":472},"lat":{"type":"number","minimum":-90,"maximum":90},"lng":{"type":"number","minimum":-180,"maximum":180},"phone":{"anyOf":[{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},{"type":"null"}]},"hours":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"seasonal":{"type":"string","enum":["yes","no"]},"services":{"type":"array","items":{"anyOf":[{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},{"type":"string","enum":["Grain","Crop Protection","Liquid Fert","Seed","Rail"]}]},"maxItems":14}},"required":["kind","locationId","name","city","state","address","lat","lng","phone","hours","seasonal","services"],"additionalProperties":false}]}},"setUpElevator":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]}},"required":["rows","bins","sites","setUpElevator"],"additionalProperties":false}
grain.elevatorTicketsRead an elevator’s weighed tickets. UI supported

Input shape documented

FieldLogical typePresence
elevatorIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["elevatorId"]}

Output shape documented

FieldLogical typePresence
weighedobject | nullrequired
3 schema notes
  • $.weighed.tickets[].netBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.weighed.tickets[].moisture refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.weighed.netBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"weighed":{"anyOf":[{"type":"object","properties":{"tickets":{"type":"array","items":{"type":"object","properties":{"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ticketNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"day":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"contractNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"netBu":{"type":"number","minimum":0,"maximum":100000000},"moisture":{"type":"number","minimum":0,"maximum":100},"moistureHigh":{"type":"boolean"},"status":{"type":"string","enum":["entered","applied","in settlement","settled"]},"alertLevel":{"type":"integer","minimum":0,"maximum":2},"alert":{"anyOf":[{"type":"string","enum":["off-grade","rejected"]},{"type":"null"}]}},"required":["ticketId","ticketNo","day","contractNo","netBu","moisture","moistureHigh","status","alertLevel","alert"],"additionalProperties":false}},"count":{"type":"integer","minimum":0,"maximum":9007199254740991},"netBu":{"type":"number","minimum":0,"maximum":100000000}},"required":["tickets","count","netBu"],"additionalProperties":false},{"type":"null"}]}},"required":["weighed"],"additionalProperties":false}
grain.enterTicketBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
slotIdstring (uuid)required
grossLbnumberrequired
tareLbnumberrequired
moisturenumberrequired
testWeightnumberrequired
gradeFactorsobjectrequired
spotPriceUnitPricemay be omitted
odor"None" | "Sour" | "Musty" | "COFO"required
infested"No" | "Yes"required
loadSplitarray of objectmay be omitted
14 schema notes
  • $.grossLb refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tareLb refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.moisture refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.testWeight refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.gradeFactors.fm refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.gradeFactors.bcfm refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.gradeFactors.damage refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.gradeFactors.heatDamage refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.gradeFactors.splits refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.gradeFactors.protein refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.gradeFactors.dockage refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.spotPrice refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.loadSplit refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.loadSplit[].sharePct refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"slotId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"grossLb":{"type":"number","minimum":0,"maximum":200000},"tareLb":{"type":"number","minimum":0,"maximum":200000},"moisture":{"type":"number","minimum":0,"maximum":100},"testWeight":{"type":"number","minimum":0,"maximum":80},"gradeFactors":{"type":"object","properties":{"fm":{"type":"number","minimum":0,"maximum":100},"bcfm":{"type":"number","minimum":0,"maximum":100},"damage":{"type":"number","minimum":0,"maximum":100},"heatDamage":{"type":"number","minimum":0,"maximum":100},"splits":{"type":"number","minimum":0,"maximum":100},"protein":{"type":"number","minimum":0,"maximum":100},"dockage":{"type":"number","minimum":0,"maximum":100}}},"spotPrice":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"odor":{"type":"string","enum":["None","Sour","Musty","COFO"]},"infested":{"type":"string","enum":["No","Yes"]},"loadSplit":{"type":"array","items":{"type":"object","properties":{"account":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sharePct":{"type":"number","minimum":0,"maximum":100}},"required":["account","sharePct"]}}},"required":["slotId","grossLb","tareLb","moisture","testWeight","gradeFactors","odor","infested"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["ticketId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"slot_received"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"readings_reversed"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"grower_is_counterparty"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.enterWalkInTicketBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
grossLbnumberrequired
tareLbnumberrequired
moisturenumberrequired
testWeightnumberrequired
gradeFactorsobjectrequired
spotPriceUnitPricemay be omitted
odor"None" | "Sour" | "Musty" | "COFO"required
infested"No" | "Yes"required
loadSplitarray of objectmay be omitted
contractIdstring (uuid)required
binstring (uuid)required
14 schema notes
  • $.grossLb refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tareLb refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.moisture refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.testWeight refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.gradeFactors.fm refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.gradeFactors.bcfm refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.gradeFactors.damage refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.gradeFactors.heatDamage refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.gradeFactors.splits refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.gradeFactors.protein refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.gradeFactors.dockage refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.spotPrice refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.loadSplit refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.loadSplit[].sharePct refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"grossLb":{"type":"number","minimum":0,"maximum":200000},"tareLb":{"type":"number","minimum":0,"maximum":200000},"moisture":{"type":"number","minimum":0,"maximum":100},"testWeight":{"type":"number","minimum":0,"maximum":80},"gradeFactors":{"type":"object","properties":{"fm":{"type":"number","minimum":0,"maximum":100},"bcfm":{"type":"number","minimum":0,"maximum":100},"damage":{"type":"number","minimum":0,"maximum":100},"heatDamage":{"type":"number","minimum":0,"maximum":100},"splits":{"type":"number","minimum":0,"maximum":100},"protein":{"type":"number","minimum":0,"maximum":100},"dockage":{"type":"number","minimum":0,"maximum":100}}},"spotPrice":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"odor":{"type":"string","enum":["None","Sour","Musty","COFO"]},"infested":{"type":"string","enum":["No","Yes"]},"loadSplit":{"type":"array","items":{"type":"object","properties":{"account":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sharePct":{"type":"number","minimum":0,"maximum":100}},"required":["account","sharePct"]}},"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"bin":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["grossLb","tareLb","moisture","testWeight","gradeFactors","odor","infested","contractId","bin"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["ticketId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"contract_not_open"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"bin_not_offered"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"readings_reversed"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"grower_is_counterparty"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.exportSettlementBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
ticketIdsarray of string (uuid)required
Full logical schema
{"type":"object","properties":{"ticketIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"minItems":1}},"required":["ticketIds"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"batchId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"exportId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["batchId","exportId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"mixed_payees"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.extractTicketBusiness procedure UI supported

Input contains unmodeled nodes

FieldLogical typePresence
pickIdstring (uuid)required
fileUnmodeled: filerequired
1 schema note
  • $.file unsupported: This schema node is unmodeled. Displayed component or inner shapes are informational; no accepted value shape is inferred for the missing representation.
Full logical schema
{"type":"object","properties":{"pickId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"file":{"x-unsupported":"file"}},"required":["pickId","file"]}

Output shape documented

object | object

11 schema notes
  • $|0.value.readings.grossLb refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.readings.tareLb refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.readings.moisture refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.readings.testWeight refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.readings.gradeFactors.fm refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.readings.gradeFactors.bcfm refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.readings.gradeFactors.damage refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.readings.gradeFactors.heatDamage refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.readings.gradeFactors.splits refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.readings.gradeFactors.protein refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.readings.gradeFactors.dockage refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"pickId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"readings":{"type":"object","properties":{"grossLb":{"type":"number","minimum":0,"maximum":200000},"tareLb":{"type":"number","minimum":0,"maximum":200000},"moisture":{"type":"number","minimum":0,"maximum":100},"testWeight":{"type":"number","minimum":0,"maximum":80},"gradeFactors":{"type":"object","properties":{"fm":{"type":"number","minimum":0,"maximum":100},"bcfm":{"type":"number","minimum":0,"maximum":100},"damage":{"type":"number","minimum":0,"maximum":100},"heatDamage":{"type":"number","minimum":0,"maximum":100},"splits":{"type":"number","minimum":0,"maximum":100},"protein":{"type":"number","minimum":0,"maximum":100},"dockage":{"type":"number","minimum":0,"maximum":100}},"additionalProperties":false}},"required":["grossLb","tareLb","moisture","testWeight","gradeFactors"],"additionalProperties":false}},"required":["pickId","readings"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"parse_failed"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.futuresBoardRead grain futures prices. UI supported

Input shape documented

FieldLogical typePresence
crop"Corn" | "Soybeans" | "Wheat" | "Sorghum" | "Barley" | "Oats" | "Rye" | "Canola" | "Sunflower"required
Full logical schema
{"type":"object","properties":{"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]}},"required":["crop"]}

Output shape documented

FieldLogical typePresence
monthsarray of objectrequired
3 schema notes
  • $.months[].futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.months[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.months[].last refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"months":{"type":"array","items":{"type":"object","properties":{"futuresMonth":{"type":"string","minLength":1,"maxLength":200},"label":{"type":"string","minLength":1,"maxLength":200},"last":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]}},"required":["futuresMonth","label","last"],"additionalProperties":false}}},"required":["months"],"additionalProperties":false}
grain.grainPositionsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
Full logical schema
{"type":"object","properties":{}}

Output shape documented

FieldLogical typePresence
rowsarray of object | objectrequired
summaryobjectrequired
receiptsarray of objectrequired
todayCalendarDayrequired
deductionDetailsobjectrequired
74 schema notes
  • $.rows[]|0.account refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.elevator refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.deliveryBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.avgMoisture refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.avgTestWeight refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.avgDamage refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.avgFm refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.settles.*.standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.settles.*.settleBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.settles.*.shrinkBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.compare.*[].standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.compare.*[].settleBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.compare.*[].vsCurrent refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.loads[].grossLb refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.loads[].tareLb refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.loads[].netLb refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.loads[].netBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.loads[].testWeight refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.loads[].moisture refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.loads[].damage refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.loads[].fm refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.warnings.*[]|0.holders refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.money.*|0.prices[].price refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.money.*|0.prices[].bu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.money.*|0.discount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.money.*|0.deductions[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.money.*|0.amountLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.money.*|1.prices[].price refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.money.*|1.prices[].bu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.money.*|1.deductions[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.account refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.elevator refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.deliveryBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.avgMoisture refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.avgTestWeight refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.avgDamage refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.avgFm refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.settles.*.standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.settles.*.settleBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.settles.*.shrinkBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.compare.*[].standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.compare.*[].settleBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.compare.*[].vsCurrent refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.loads[].grossLb refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.loads[].tareLb refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.loads[].netLb refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.loads[].netBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.loads[].testWeight refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.loads[].moisture refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.loads[].damage refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.loads[].fm refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.warnings.*[]|0.holders refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.money|0.prices[].price refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.money|0.prices[].bu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.money|0.discount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.money|0.deductions[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.money|0.amountLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.money|1.prices[].price refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.money|1.prices[].bu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.money|1.deductions[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.summary.rows[].corn refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.summary.rows[].soybeans refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.summary.rows[].other refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.summary.total.corn refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.summary.total.soybeans refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.summary.total.other refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.receipts[].account refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.receipts[].storedBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.receipts[].soldBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.receipts[].remainingBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.receipts[].postedBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.receipts[].avgMoisture refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.receipts[].cashBid refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.deductionDetails.* refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"open"},"deliveryNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"account":{"type":"string","minLength":1,"maxLength":200},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"elevator":{"type":"string","minLength":1,"maxLength":200},"loadCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"deliveryBu":{"type":"number","minimum":0,"maximum":100000000},"firstLoadOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"avgMoisture":{"type":"number","minimum":0,"maximum":100},"avgTestWeight":{"type":"number","minimum":0,"maximum":100},"avgDamage":{"anyOf":[{"type":"number","minimum":0,"maximum":100},{"type":"null"}]},"avgFm":{"anyOf":[{"type":"number","minimum":0,"maximum":100},{"type":"null"}]},"settles":{"type":"object","propertyNames":{"type":"string","enum":["Immediate Pay","Deferred Payment","Warehouse","Price Later","Grain Bank"]},"additionalProperties":{"type":"object","properties":{"standard":{"type":"number","minimum":0,"maximum":100},"settleBu":{"type":"number","minimum":0,"maximum":100000000},"shrinkBu":{"type":"number","minimum":0,"maximum":100000000}},"required":["standard","settleBu","shrinkBu"],"additionalProperties":false},"required":["Immediate Pay","Deferred Payment","Warehouse","Price Later","Grain Bank"]},"compare":{"type":"object","propertyNames":{"type":"string","enum":["Immediate Pay","Deferred Payment","Warehouse","Price Later","Grain Bank"]},"additionalProperties":{"type":"array","items":{"type":"object","properties":{"disposition":{"type":"string","enum":["Immediate Pay","Deferred Payment","Warehouse","Price Later","Grain Bank"]},"standard":{"type":"number","minimum":0,"maximum":100},"settleBu":{"type":"number","minimum":0,"maximum":100000000},"vsCurrent":{"type":"number","minimum":-100000000,"maximum":100000000},"mark":{"type":"string","enum":["above","below","same"]}},"required":["disposition","standard","settleBu","vsCurrent","mark"],"additionalProperties":false}},"required":["Immediate Pay","Deferred Payment","Warehouse","Price Later","Grain Bank"]},"loads":{"type":"array","items":{"type":"object","properties":{"ticketNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"day":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"grossLb":{"type":"number","minimum":0,"maximum":200000},"tareLb":{"type":"number","minimum":0,"maximum":200000},"netLb":{"type":"number","minimum":0,"maximum":200000},"netBu":{"type":"number","minimum":0,"maximum":100000000},"testWeight":{"type":"number","minimum":0,"maximum":80},"moisture":{"type":"number","minimum":0,"maximum":100},"moistureOverDrying":{"type":"boolean"},"damage":{"anyOf":[{"type":"number","minimum":0,"maximum":100},{"type":"null"}]},"fm":{"anyOf":[{"type":"number","minimum":0,"maximum":100},{"type":"null"}]}},"required":["ticketNo","day","grossLb","tareLb","netLb","netBu","testWeight","moisture","moistureOverDrying","damage","fm"],"additionalProperties":false}},"warnings":{"type":"object","propertyNames":{"type":"string","enum":["Immediate Pay","Deferred Payment","Warehouse","Price Later","Grain Bank"]},"additionalProperties":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"jointCheck"},"holders":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","holders"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"deferralDisclosure"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"priceLater"}},"required":["kind"],"additionalProperties":false}]}},"required":["Immediate Pay","Deferred Payment","Warehouse","Price Later","Grain Bank"]},"delivery":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"group"},"growerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","growerId","crop","elevatorId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"alone"},"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","ticketId"],"additionalProperties":false}]},"settle":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]},"settleTo":{"type":"object","propertyNames":{"type":"string","enum":["Immediate Pay","Deferred Payment","Warehouse","Price Later","Grain Bank"]},"additionalProperties":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","const":"not_priced"}},"required":["status","error"],"additionalProperties":false}]},"required":["Immediate Pay","Deferred Payment","Warehouse","Price Later","Grain Bank"]},"money":{"type":"object","propertyNames":{"type":"string","enum":["Immediate Pay","Deferred Payment","Warehouse","Price Later","Grain Bank"]},"additionalProperties":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"paid"},"rejected":{"type":"boolean"},"prices":{"type":"array","items":{"type":"object","properties":{"price":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"bu":{"type":"number","minimum":0,"maximum":100000000}},"required":["price","bu"],"additionalProperties":false}},"discount":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"totalGross":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"deductions":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["checkoff","indemnity","inspection","drying","storage","freight"]},"label":{"type":"string","minLength":1,"maxLength":200},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","label","amount"],"additionalProperties":false}},"totalDeductions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"payable":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"amountLabel":{"type":"string","minLength":1,"maxLength":200},"payDate":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]}},"required":["kind","rejected","prices","discount","totalGross","deductions","totalDeductions","payable","amountLabel","payDate"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"accrues"},"rejected":{"type":"boolean"},"prices":{"type":"array","items":{"type":"object","properties":{"price":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"bu":{"type":"number","minimum":0,"maximum":100000000}},"required":["price","bu"],"additionalProperties":false}},"deductions":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["checkoff","indemnity","inspection","drying","storage","freight"]},"label":{"type":"string","minLength":1,"maxLength":200},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","label","amount"],"additionalProperties":false}},"totalDeductions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","rejected","prices","deductions","totalDeductions"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unpriced"},"rejected":{"type":"boolean"},"reason":{"type":"string","enum":["layered","noCashBid"]}},"required":["kind","rejected","reason"],"additionalProperties":false}]},"required":["Immediate Pay","Deferred Payment","Warehouse","Price Later","Grain Bank"]}},"required":["status","deliveryNo","account","crop","elevator","loadCount","deliveryBu","firstLoadOn","avgMoisture","avgTestWeight","avgDamage","avgFm","settles","compare","loads","warnings","delivery","settle","settleTo","money"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"settled"},"deliveryNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"account":{"type":"string","minLength":1,"maxLength":200},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"elevator":{"type":"string","minLength":1,"maxLength":200},"loadCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"deliveryBu":{"type":"number","minimum":0,"maximum":100000000},"firstLoadOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"avgMoisture":{"type":"number","minimum":0,"maximum":100},"avgTestWeight":{"type":"number","minimum":0,"maximum":100},"avgDamage":{"anyOf":[{"type":"number","minimum":0,"maximum":100},{"type":"null"}]},"avgFm":{"anyOf":[{"type":"number","minimum":0,"maximum":100},{"type":"null"}]},"settles":{"type":"object","propertyNames":{"type":"string","enum":["Immediate Pay","Deferred Payment","Warehouse","Price Later","Grain Bank"]},"additionalProperties":{"type":"object","properties":{"standard":{"type":"number","minimum":0,"maximum":100},"settleBu":{"type":"number","minimum":0,"maximum":100000000},"shrinkBu":{"type":"number","minimum":0,"maximum":100000000}},"required":["standard","settleBu","shrinkBu"],"additionalProperties":false},"required":["Immediate Pay","Deferred Payment","Warehouse","Price Later","Grain Bank"]},"compare":{"type":"object","propertyNames":{"type":"string","enum":["Immediate Pay","Deferred Payment","Warehouse","Price Later","Grain Bank"]},"additionalProperties":{"type":"array","items":{"type":"object","properties":{"disposition":{"type":"string","enum":["Immediate Pay","Deferred Payment","Warehouse","Price Later","Grain Bank"]},"standard":{"type":"number","minimum":0,"maximum":100},"settleBu":{"type":"number","minimum":0,"maximum":100000000},"vsCurrent":{"type":"number","minimum":-100000000,"maximum":100000000},"mark":{"type":"string","enum":["above","below","same"]}},"required":["disposition","standard","settleBu","vsCurrent","mark"],"additionalProperties":false}},"required":["Immediate Pay","Deferred Payment","Warehouse","Price Later","Grain Bank"]},"loads":{"type":"array","items":{"type":"object","properties":{"ticketNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"day":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"grossLb":{"type":"number","minimum":0,"maximum":200000},"tareLb":{"type":"number","minimum":0,"maximum":200000},"netLb":{"type":"number","minimum":0,"maximum":200000},"netBu":{"type":"number","minimum":0,"maximum":100000000},"testWeight":{"type":"number","minimum":0,"maximum":80},"moisture":{"type":"number","minimum":0,"maximum":100},"moistureOverDrying":{"type":"boolean"},"damage":{"anyOf":[{"type":"number","minimum":0,"maximum":100},{"type":"null"}]},"fm":{"anyOf":[{"type":"number","minimum":0,"maximum":100},{"type":"null"}]}},"required":["ticketNo","day","grossLb","tareLb","netLb","netBu","testWeight","moisture","moistureOverDrying","damage","fm"],"additionalProperties":false}},"warnings":{"type":"object","propertyNames":{"type":"string","enum":["Immediate Pay","Deferred Payment","Warehouse","Price Later","Grain Bank"]},"additionalProperties":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"jointCheck"},"holders":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","holders"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"deferralDisclosure"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"priceLater"}},"required":["kind"],"additionalProperties":false}]}},"required":["Immediate Pay","Deferred Payment","Warehouse","Price Later","Grain Bank"]},"settlementNo":{"type":"string","pattern":"^DS-\\d+$"},"settledAt":{"type":"string","format":"date-time","x-zod-type":"date"},"disposition":{"type":"string","enum":["Immediate Pay","Deferred Payment","Warehouse","Price Later","Grain Bank"]},"payDate":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"money":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"paid"},"rejected":{"type":"boolean"},"prices":{"type":"array","items":{"type":"object","properties":{"price":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"bu":{"type":"number","minimum":0,"maximum":100000000}},"required":["price","bu"],"additionalProperties":false}},"discount":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"totalGross":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"deductions":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["checkoff","indemnity","inspection","drying","storage","freight"]},"label":{"type":"string","minLength":1,"maxLength":200},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","label","amount"],"additionalProperties":false}},"totalDeductions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"payable":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"amountLabel":{"type":"string","minLength":1,"maxLength":200},"payDate":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]}},"required":["kind","rejected","prices","discount","totalGross","deductions","totalDeductions","payable","amountLabel","payDate"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"accrues"},"rejected":{"type":"boolean"},"prices":{"type":"array","items":{"type":"object","properties":{"price":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"bu":{"type":"number","minimum":0,"maximum":100000000}},"required":["price","bu"],"additionalProperties":false}},"deductions":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["checkoff","indemnity","inspection","drying","storage","freight"]},"label":{"type":"string","minLength":1,"maxLength":200},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","label","amount"],"additionalProperties":false}},"totalDeductions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","rejected","prices","deductions","totalDeductions"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unpriced"},"rejected":{"type":"boolean"}},"required":["kind","rejected"],"additionalProperties":false}]}},"required":["status","deliveryNo","account","crop","elevator","loadCount","deliveryBu","firstLoadOn","avgMoisture","avgTestWeight","avgDamage","avgFm","settles","compare","loads","warnings","settlementNo","settledAt","disposition","payDate","money"],"additionalProperties":false}]}},"summary":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"corn":{"type":"number","minimum":0,"maximum":100000000},"soybeans":{"type":"number","minimum":0,"maximum":100000000},"other":{"type":"number","minimum":0,"maximum":100000000},"type":{"type":"string","enum":["Unsettled Deliveries","Storage","Price Later","Purchase Contracts","Offer Contracts","Structured Products","Grain Bank"]}},"required":["corn","soybeans","other","type"],"additionalProperties":false}},"total":{"type":"object","properties":{"corn":{"type":"number","minimum":0,"maximum":100000000},"soybeans":{"type":"number","minimum":0,"maximum":100000000},"other":{"type":"number","minimum":0,"maximum":100000000}},"required":["corn","soybeans","other"],"additionalProperties":false},"openDeliveries":{"type":"integer","minimum":0,"maximum":9007199254740991},"loadsAwaiting":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["rows","total","openDeliveries","loadsAwaiting"],"additionalProperties":false},"receipts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"receiptNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"account":{"type":"string","minLength":1,"maxLength":200},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"receiptType":{"type":"string","enum":["Negotiable","Non-negotiable"]},"storedOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"storedBu":{"type":"number","minimum":0,"maximum":100000000},"soldBu":{"type":"number","minimum":0,"maximum":100000000},"remainingBu":{"type":"number","minimum":0,"maximum":100000000},"status":{"type":"string","enum":["open","closed"]},"postedBu":{"type":"number","minimum":0,"maximum":100000000},"avgMoisture":{"type":"number","minimum":0,"maximum":100},"cashBid":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"sell":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["receipt_closed","sell_over_remaining"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["id","receiptNo","account","crop","receiptType","storedOn","storedBu","soldBu","remainingBu","status","postedBu","avgMoisture","cashBid","sell"],"additionalProperties":false}},"today":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"deductionDetails":{"type":"object","propertyNames":{"type":"string","enum":["checkoff","indemnity","inspection","drying","storage","freight"]},"additionalProperties":{"type":"string","minLength":1,"maxLength":200},"required":["checkoff","indemnity","inspection","drying","storage","freight"]}},"required":["rows","summary","receipts","today","deductionDetails"],"additionalProperties":false}
grain.growerBidsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealerstring (uuid)required
Full logical schema
{"type":"object","properties":{"dealer":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealer"],"additionalProperties":false}

Output shape documented

FieldLogical typePresence
asOfCalendarDayrequired
locationsarray of objectrequired
8 schema notes
  • $.locations[].name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.locations[].city refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.locations[].crops[].bids[].deliveryLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.locations[].crops[].bids[].futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.locations[].crops[].bids[].futuresLast refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.locations[].crops[].bids[].basis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.locations[].crops[].bids[].bid refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.locations[].crops[].bids[].change refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"asOf":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"locations":{"type":"array","items":{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":200},"city":{"type":"string","minLength":1,"maxLength":200},"crops":{"type":"array","items":{"type":"object","properties":{"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"bids":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"deliveryMonth":{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"},"deliveryLabel":{"type":"string","minLength":1,"maxLength":200},"futuresMonth":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"futuresLast":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"basis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"bid":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"change":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"postedOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["id","crop","deliveryMonth","deliveryLabel","futuresMonth","futuresLast","basis","bid","change","postedOn"],"additionalProperties":false}}},"required":["crop","bids"],"additionalProperties":false}}},"required":["elevatorId","name","city","crops"],"additionalProperties":false}}},"required":["asOf","locations"],"additionalProperties":false}
grain.growerContractBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealerstring (uuid)required
contractIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"dealer":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealer","contractId"],"additionalProperties":false}

Output shape documented

FieldLogical typePresence
idstring (uuid)required
contractNostringrequired
crop"Corn" | "Soybeans" | "Wheat" | "Sorghum" | "Barley" | "Oats" | "Rye" | "Canola" | "Sunflower"required
cropClassstringmay be omitted
dealType"origination" | "direct-ship" | "storage / DP"required
contractType"full priced" | "futures only" | "basis only" | "delayed price"required
valuationobjectrequired
lockedBasisUnitPricemay be omitted
futuresMonthstringmay be omitted
unpricedBunumbermay be omitted
pricedBunumberrequired
commitmentBunumberrequired
filledBunumberrequired
openBunumberrequired
deliveryMonthstringmay be omitted
targetStartCalendarDaymay be omitted
targetEndCalendarDaymay be omitted
signingDeadlineAtstring (date-time)may be omitted
ownSharePctnumberrequired
averageLoadBunumber | nullrequired
tripsLeftinteger | nullrequired
status"awaiting-sig" | "signed" | "active" | "expired" | "filled" | "stored" | "cancelled" | "bought out"required
statusLabelstringrequired
pricingHeldobject | object | object | objectrequired
ownValueobject | objectrequired
19 schema notes
  • $.cropClass refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.valuation.rolls refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.valuation.atBoard|3.quote.futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.valuation.atBoard|3.quote.last refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.valuation.atBoard|3.quote.change refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.valuation.atBoard|3.basis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.valuation.atBoard|3.rolls refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.valuation.atBoard|3.price refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.valuation.atBoard|3.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lockedBasis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.unpricedBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.pricedBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.commitmentBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.filledBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.openBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.deliveryMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ownSharePct refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.averageLoadBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"cropClass":{"type":"string","minLength":1,"maxLength":200},"dealType":{"type":"string","enum":["origination","direct-ship","storage / DP"]},"contractType":{"type":"string","enum":["full priced","futures only","basis only","delayed price"]},"valuation":{"type":"object","properties":{"priceLabel":{"type":"string","minLength":1,"maxLength":255},"rolls":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"pricedValue":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","amount"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","reason"],"additionalProperties":false}]},"atBoard":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"none"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"basisOpen"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unquoted"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"quoted"},"quote":{"type":"object","properties":{"futuresMonth":{"type":"string","minLength":1,"maxLength":200},"last":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"change":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]}},"required":["futuresMonth","last","change"],"additionalProperties":false},"basis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"rolls":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"price":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"bushels":{"type":"number","minimum":0,"maximum":100000000},"contractValue":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"value":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","amount"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","reason"],"additionalProperties":false}]}},"required":["kind","quote","basis","rolls","price","bushels","contractValue","value"],"additionalProperties":false}]}},"required":["priceLabel","rolls","pricedValue","atBoard"],"additionalProperties":false},"lockedBasis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"futuresMonth":{"type":"string","minLength":1,"maxLength":200},"unpricedBu":{"type":"number","minimum":0,"maximum":100000000},"pricedBu":{"type":"number","minimum":0,"maximum":100000000},"commitmentBu":{"type":"number","minimum":0,"maximum":100000000},"filledBu":{"type":"number","minimum":0,"maximum":100000000},"openBu":{"type":"number","minimum":0,"maximum":100000000},"deliveryMonth":{"type":"string","minLength":1,"maxLength":200},"targetStart":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"targetEnd":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"signingDeadlineAt":{"type":"string","format":"date-time","x-zod-type":"date"},"ownSharePct":{"type":"number","minimum":0,"maximum":100},"averageLoadBu":{"anyOf":[{"type":"number","minimum":0,"maximum":100000000},{"type":"null"}]},"tripsLeft":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":100000},{"type":"null"}]},"status":{"type":"string","enum":["awaiting-sig","signed","active","expired","filled","stored","cancelled","bought out"]},"statusLabel":{"type":"string","minLength":1,"maxLength":255},"pricingHeld":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["not_awaiting_sig","contract_not_open","no_futures_month","over_contract","fully_priced","priced_before_signed","nothing_open"]}},"required":["status","error"],"additionalProperties":false}]},"ownValue":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"own"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","reason"],"additionalProperties":false}]}},"required":["id","contractNo","crop","dealType","contractType","valuation","pricedBu","commitmentBu","filledBu","openBu","ownSharePct","averageLoadBu","tripsLeft","status","statusLabel","pricingHeld","ownValue"],"additionalProperties":false}
grain.growerContractsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealerstring (uuid)required
Full logical schema
{"type":"object","properties":{"dealer":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealer"],"additionalProperties":false}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
totalintegerrequired
nextCursorstring | nullrequired
19 schema notes
  • $.rows[].cropClass refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].valuation.rolls refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].valuation.atBoard|3.quote.futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].valuation.atBoard|3.quote.last refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].valuation.atBoard|3.quote.change refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].valuation.atBoard|3.basis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].valuation.atBoard|3.rolls refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].valuation.atBoard|3.price refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].valuation.atBoard|3.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].lockedBasis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].unpricedBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].pricedBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].commitmentBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].filledBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].openBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].deliveryMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].ownSharePct refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].averageLoadBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"cropClass":{"type":"string","minLength":1,"maxLength":200},"dealType":{"type":"string","enum":["origination","direct-ship","storage / DP"]},"contractType":{"type":"string","enum":["full priced","futures only","basis only","delayed price"]},"valuation":{"type":"object","properties":{"priceLabel":{"type":"string","minLength":1,"maxLength":255},"rolls":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"pricedValue":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","amount"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","reason"],"additionalProperties":false}]},"atBoard":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"none"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"basisOpen"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unquoted"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"quoted"},"quote":{"type":"object","properties":{"futuresMonth":{"type":"string","minLength":1,"maxLength":200},"last":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"change":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]}},"required":["futuresMonth","last","change"],"additionalProperties":false},"basis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"rolls":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"price":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"bushels":{"type":"number","minimum":0,"maximum":100000000},"contractValue":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"value":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","amount"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","reason"],"additionalProperties":false}]}},"required":["kind","quote","basis","rolls","price","bushels","contractValue","value"],"additionalProperties":false}]}},"required":["priceLabel","rolls","pricedValue","atBoard"],"additionalProperties":false},"lockedBasis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"futuresMonth":{"type":"string","minLength":1,"maxLength":200},"unpricedBu":{"type":"number","minimum":0,"maximum":100000000},"pricedBu":{"type":"number","minimum":0,"maximum":100000000},"commitmentBu":{"type":"number","minimum":0,"maximum":100000000},"filledBu":{"type":"number","minimum":0,"maximum":100000000},"openBu":{"type":"number","minimum":0,"maximum":100000000},"deliveryMonth":{"type":"string","minLength":1,"maxLength":200},"targetStart":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"targetEnd":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"signingDeadlineAt":{"type":"string","format":"date-time","x-zod-type":"date"},"ownSharePct":{"type":"number","minimum":0,"maximum":100},"averageLoadBu":{"anyOf":[{"type":"number","minimum":0,"maximum":100000000},{"type":"null"}]},"tripsLeft":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":100000},{"type":"null"}]},"status":{"type":"string","enum":["awaiting-sig","signed","active","expired","filled","stored","cancelled","bought out"]},"statusLabel":{"type":"string","minLength":1,"maxLength":255},"pricingHeld":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["not_awaiting_sig","contract_not_open","no_futures_month","over_contract","fully_priced","priced_before_signed","nothing_open"]}},"required":["status","error"],"additionalProperties":false}]},"ownValue":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"own"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","reason"],"additionalProperties":false}]}},"required":["id","contractNo","crop","dealType","contractType","valuation","pricedBu","commitmentBu","filledBu","openBu","ownSharePct","averageLoadBu","tripsLeft","status","statusLabel","pricingHeld","ownValue"],"additionalProperties":false}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["rows","total","nextCursor"],"additionalProperties":false}
grain.growerDocumentsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealerstring (uuid)required
Full logical schema
{"type":"object","properties":{"dealer":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealer"],"additionalProperties":false}

Output shape documented

FieldLogical typePresence
sampleDocumentsarray of objectrequired
zonestringrequired
contractsarray of objectrequired
rowsarray of objectrequired
locationsarray of objectrequired
invoicesarray of objectrequired
10 schema notes
  • $.sampleDocuments[].id refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sampleDocuments[].reference refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sampleDocuments runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.zone refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].period refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].total.reason refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.locations[].name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.locations[].address.city refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.locations[].hours refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.invoices[].reference refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"sampleDocuments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":200},"kind":{"type":"string","enum":["RUP","Tax exemption","Pesticide application records"]},"reference":{"type":"string","minLength":1,"maxLength":200},"date":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"sample":{"type":"boolean","const":true}},"required":["id","kind","reference","date","sample"],"additionalProperties":false}},"zone":{"type":"string"},"contracts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reference":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"date":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["id","reference","date"],"additionalProperties":false}},"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"period":{"type":"string","minLength":1,"maxLength":200},"date":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"total":{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","reason"],"additionalProperties":false}},"required":["id","period","date","total"],"additionalProperties":false}},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":200},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"city":{"type":"string","minLength":1,"maxLength":200},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["city","state"],"additionalProperties":false},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"hours":{"type":"string","minLength":1,"maxLength":200}},"required":["id","name","address"],"additionalProperties":false}},"invoices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reference":{"type":"string","minLength":1,"maxLength":200},"date":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["id","reference","date"],"additionalProperties":false}}},"required":["sampleDocuments","zone","contracts","rows","locations","invoices"],"additionalProperties":false}
grain.growerMarketBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealerstring (uuid)required
Full logical schema
{"type":"object","properties":{"dealer":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealer"],"additionalProperties":false}

Output shape documented

FieldLogical typePresence
boardarray of objectrequired
unpricedarray of objectrequired
5 schema notes
  • $.board[].months[].futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.board[].months[].last refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.board[].months[].change refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.unpriced[].bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.unpriced[].shared.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"board":{"type":"array","items":{"type":"object","properties":{"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"months":{"type":"array","items":{"type":"object","properties":{"futuresMonth":{"type":"string","minLength":1,"maxLength":200},"last":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"change":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]}},"required":["futuresMonth","last","change"],"additionalProperties":false}}},"required":["crop","months"],"additionalProperties":false}},"unpriced":{"type":"array","items":{"type":"object","properties":{"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"bushels":{"type":"number","minimum":0,"maximum":100000000},"shared":{"anyOf":[{"type":"object","properties":{"bushels":{"type":"number","minimum":0,"maximum":100000000},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["bushels","reason"],"additionalProperties":false},{"type":"null"}]}},"required":["crop","bushels","shared"],"additionalProperties":false}}},"required":["board","unpriced"],"additionalProperties":false}
grain.growerPositionsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealerstring (uuid)required
Full logical schema
{"type":"object","properties":{"dealer":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealer"],"additionalProperties":false}

Output shape documented

FieldLogical typePresence
asOfCalendarDayrequired
cropsarray of objectrequired
storedarray of objectrequired
comingInarray of objectrequired
9 schema notes
  • $.crops[].contractedBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.crops[].pricedBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.crops[].unpricedBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.crops[].valuation.atBoard|3.quotes[].futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.crops[].valuation.atBoard|3.quotes[].last refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.crops[].valuation.atBoard|3.quotes[].change refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.stored[].receipts[].remainingBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.stored[].storedBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.stored[].deliveredUnpricedBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"asOf":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"crops":{"type":"array","items":{"type":"object","properties":{"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"fieldCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"acres":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"none"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"known"},"acres":{"anyOf":[{"type":"number","const":0},{"type":"number","exclusiveMinimum":0,"maximum":200000,"format":"number"}]}},"required":["kind","acres"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","reason"],"additionalProperties":false}]},"contractedBu":{"type":"number","minimum":0,"maximum":100000000},"contractedValue":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"own"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","reason"],"additionalProperties":false}]},"pricedBu":{"type":"number","minimum":0,"maximum":100000000},"unpricedBu":{"type":"number","minimum":0,"maximum":100000000},"unpricedValue":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"own"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","reason"],"additionalProperties":false}]},"valuation":{"type":"object","properties":{"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"pricedValue":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","amount"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","reason"],"additionalProperties":false}]},"atBoard":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"none"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"basisOpen"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unquoted"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"quoted"},"quotes":{"type":"array","items":{"type":"object","properties":{"futuresMonth":{"type":"string","minLength":1,"maxLength":200},"last":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"change":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]}},"required":["futuresMonth","last","change"],"additionalProperties":false}},"rolledContracts":{"type":"integer","minimum":0,"maximum":9007199254740991},"value":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","amount"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","reason"],"additionalProperties":false}]}},"required":["kind","quotes","rolledContracts","value"],"additionalProperties":false}]}},"required":["crop","pricedValue","atBoard"],"additionalProperties":false}},"required":["crop","fieldCount","acres","contractedBu","contractedValue","pricedBu","unpricedBu","unpricedValue","valuation"],"additionalProperties":false}},"stored":{"type":"array","items":{"type":"object","properties":{"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"receipts":{"type":"array","items":{"type":"object","properties":{"receiptNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"storedOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"remainingBu":{"type":"number","minimum":0,"maximum":100000000},"storage":{"anyOf":[{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"posted"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","amount"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","reason"],"additionalProperties":false}]},{"type":"null"}]}},"required":["receiptNo","storedOn","remainingBu","storage"],"additionalProperties":false}},"storedBu":{"type":"number","minimum":0,"maximum":100000000},"deliveredUnpricedBu":{"type":"number","minimum":0,"maximum":100000000},"decideBy":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"otherStorage":{"anyOf":[{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"posted"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","amount"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","reason"],"additionalProperties":false}]},{"type":"null"}]}},"required":["crop","receipts","storedBu","deliveredUnpricedBu","decideBy","otherStorage"],"additionalProperties":false}},"comingIn":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["settlement","payment","unsentPayment","load","contract"]},"certainty":{"type":"string","enum":["confirmed","estimate"]},"on":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"pastDueSince":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"windowEnd":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"amount":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","amount"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","reason"],"additionalProperties":false}]},"source":{"anyOf":[{"type":"string","pattern":"^DS-\\d+$"},{"type":"string","pattern":"^B-\\d+$"},{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"}]},"crops":{"type":"array","items":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]}}},"required":["kind","certainty","on","pastDueSince","windowEnd","amount","source","crops"],"additionalProperties":false}}},"required":["asOf","crops","stored","comingIn"],"additionalProperties":false}
grain.growerSettlementsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealerstring (uuid)required
Full logical schema
{"type":"object","properties":{"dealer":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealer"],"additionalProperties":false}

Output shape documented

FieldLogical typePresence
asOfCalendarDayrequired
rowsarray of object | object | object | object | objectrequired
comingInarray of objectrequired
20 schema notes
  • $.rows[]|0.ownBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.tickets[].ownBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.money|0.lines[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.money|1.reason refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.ownBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.tickets[].ownBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.money|0.lines[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.money|1.reason refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|2.ownBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|2.tickets[].ownBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|2.money|0.lines[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|2.money|1.reason refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|3.ownBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|3.tickets[].ownBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|3.money|0.lines[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|3.money|1.reason refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|4.ownBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|4.tickets[].ownBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|4.money|0.lines[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|4.money|1.reason refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"asOf":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"rows":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}]},"reference":{"anyOf":[{"type":"string","pattern":"^DS-\\d+$"},{"type":"string","pattern":"^B-\\d+$"},{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"}]},"contracts":{"type":"array","items":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"}},"ownBu":{"type":"number","minimum":0,"maximum":100000000},"date":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"receiptDate":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"dueOn":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"pastDueSince":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"timing":{"type":"string","enum":["upcoming","history","estimated"]},"tickets":{"type":"array","items":{"type":"object","properties":{"ticketNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"ownBu":{"type":"number","minimum":0,"maximum":100000000}},"required":["ticketNo","ownBu"],"additionalProperties":false}},"accountingState":{"anyOf":[{"type":"string","enum":["queued","sent","failed"]},{"type":"null"}]},"state":{"type":"string","const":"estimated"},"money":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"lines":{"type":"array","items":{"type":"object","properties":{"part":{"type":"string","enum":["gross","payable","deduction","advance","net"]},"label":{"type":"string","minLength":1,"maxLength":200},"amount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"perBu":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]}},"required":["part","label","amount","perBu"],"additionalProperties":false}},"net":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"basis":{"type":"object","properties":{"kind":{"type":"string","const":"queued"},"queuedOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","queuedOn"],"additionalProperties":false}},"required":["kind","lines","net","basis"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","reason"],"additionalProperties":false}]}},"required":["id","reference","contracts","ownBu","date","receiptDate","dueOn","pastDueSince","timing","tickets","accountingState","state","money"],"additionalProperties":false},{"type":"object","properties":{"id":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}]},"reference":{"anyOf":[{"type":"string","pattern":"^DS-\\d+$"},{"type":"string","pattern":"^B-\\d+$"},{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"}]},"contracts":{"type":"array","items":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"}},"ownBu":{"type":"number","minimum":0,"maximum":100000000},"date":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"receiptDate":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"dueOn":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"pastDueSince":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"timing":{"type":"string","enum":["upcoming","history","estimated"]},"tickets":{"type":"array","items":{"type":"object","properties":{"ticketNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"ownBu":{"type":"number","minimum":0,"maximum":100000000}},"required":["ticketNo","ownBu"],"additionalProperties":false}},"accountingState":{"anyOf":[{"type":"string","enum":["queued","sent","failed"]},{"type":"null"}]},"state":{"type":"string","enum":["queued","failed","unrecorded"]},"money":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"lines":{"type":"array","items":{"type":"object","properties":{"part":{"type":"string","enum":["gross","payable","deduction","advance","net"]},"label":{"type":"string","minLength":1,"maxLength":200},"amount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"perBu":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]}},"required":["part","label","amount","perBu"],"additionalProperties":false}},"net":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"basis":{"type":"object","properties":{"kind":{"type":"string","const":"export"}},"required":["kind"],"additionalProperties":false}},"required":["kind","lines","net","basis"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","reason"],"additionalProperties":false}]}},"required":["id","reference","contracts","ownBu","date","receiptDate","dueOn","pastDueSince","timing","tickets","accountingState","state","money"],"additionalProperties":false},{"type":"object","properties":{"id":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}]},"reference":{"anyOf":[{"type":"string","pattern":"^DS-\\d+$"},{"type":"string","pattern":"^B-\\d+$"},{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"}]},"contracts":{"type":"array","items":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"}},"ownBu":{"type":"number","minimum":0,"maximum":100000000},"date":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"receiptDate":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"dueOn":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"pastDueSince":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"timing":{"type":"string","enum":["upcoming","history","estimated"]},"tickets":{"type":"array","items":{"type":"object","properties":{"ticketNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"ownBu":{"type":"number","minimum":0,"maximum":100000000}},"required":["ticketNo","ownBu"],"additionalProperties":false}},"accountingState":{"anyOf":[{"type":"string","enum":["queued","sent","failed"]},{"type":"null"}]},"state":{"type":"string","const":"sent"},"sentOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"money":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"lines":{"type":"array","items":{"type":"object","properties":{"part":{"type":"string","enum":["gross","payable","deduction","advance","net"]},"label":{"type":"string","minLength":1,"maxLength":200},"amount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"perBu":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]}},"required":["part","label","amount","perBu"],"additionalProperties":false}},"net":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"basis":{"type":"object","properties":{"kind":{"type":"string","const":"export"}},"required":["kind"],"additionalProperties":false}},"required":["kind","lines","net","basis"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","reason"],"additionalProperties":false}]}},"required":["id","reference","contracts","ownBu","date","receiptDate","dueOn","pastDueSince","timing","tickets","accountingState","state","sentOn","money"],"additionalProperties":false},{"type":"object","properties":{"id":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}]},"reference":{"anyOf":[{"type":"string","pattern":"^DS-\\d+$"},{"type":"string","pattern":"^B-\\d+$"},{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"}]},"contracts":{"type":"array","items":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"}},"ownBu":{"type":"number","minimum":0,"maximum":100000000},"date":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"receiptDate":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"dueOn":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"pastDueSince":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"timing":{"type":"string","enum":["upcoming","history","estimated"]},"tickets":{"type":"array","items":{"type":"object","properties":{"ticketNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"ownBu":{"type":"number","minimum":0,"maximum":100000000}},"required":["ticketNo","ownBu"],"additionalProperties":false}},"accountingState":{"anyOf":[{"type":"string","enum":["queued","sent","failed"]},{"type":"null"}]},"state":{"type":"string","const":"received"},"money":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"lines":{"type":"array","items":{"type":"object","properties":{"part":{"type":"string","enum":["gross","payable","deduction","advance","net"]},"label":{"type":"string","minLength":1,"maxLength":200},"amount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"perBu":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]}},"required":["part","label","amount","perBu"],"additionalProperties":false}},"net":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"basis":{"type":"object","properties":{"kind":{"type":"string","const":"export"}},"required":["kind"],"additionalProperties":false}},"required":["kind","lines","net","basis"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","reason"],"additionalProperties":false}]}},"required":["id","reference","contracts","ownBu","date","receiptDate","dueOn","pastDueSince","timing","tickets","accountingState","state","money"],"additionalProperties":false},{"type":"object","properties":{"id":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}]},"reference":{"anyOf":[{"type":"string","pattern":"^DS-\\d+$"},{"type":"string","pattern":"^B-\\d+$"},{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"}]},"contracts":{"type":"array","items":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"}},"ownBu":{"type":"number","minimum":0,"maximum":100000000},"date":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"receiptDate":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"dueOn":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"pastDueSince":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"timing":{"type":"string","enum":["upcoming","history","estimated"]},"tickets":{"type":"array","items":{"type":"object","properties":{"ticketNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"ownBu":{"type":"number","minimum":0,"maximum":100000000}},"required":["ticketNo","ownBu"],"additionalProperties":false}},"accountingState":{"anyOf":[{"type":"string","enum":["queued","sent","failed"]},{"type":"null"}]},"state":{"type":"string","const":"posted"},"money":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"lines":{"type":"array","items":{"type":"object","properties":{"part":{"type":"string","enum":["gross","payable","deduction","advance","net"]},"label":{"type":"string","minLength":1,"maxLength":200},"amount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"perBu":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]}},"required":["part","label","amount","perBu"],"additionalProperties":false}},"net":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"basis":{"type":"object","properties":{"kind":{"type":"string","const":"posting"}},"required":["kind"],"additionalProperties":false}},"required":["kind","lines","net","basis"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":200}},"required":["kind","reason"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unpriced"}},"required":["kind"],"additionalProperties":false}]}},"required":["id","reference","contracts","ownBu","date","receiptDate","dueOn","pastDueSince","timing","tickets","accountingState","state","money"],"additionalProperties":false}]}},"comingIn":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["settlement","payment","unsentPayment","load","contract"]},"certainty":{"type":"string","enum":["confirmed","estimate"]},"on":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"pastDueSince":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"windowEnd":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"amount":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","amount"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","reason"],"additionalProperties":false}]},"source":{"anyOf":[{"type":"string","pattern":"^DS-\\d+$"},{"type":"string","pattern":"^B-\\d+$"},{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"}]},"crops":{"type":"array","items":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]}}},"required":["kind","certainty","on","pastDueSince","windowEnd","amount","source","crops"],"additionalProperties":false}}},"required":["asOf","rows","comingIn"],"additionalProperties":false}
grain.growerTermsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
growerIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"growerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["growerId"]}

Output shape documented

FieldLogical typePresence
payMethodstring | nullrequired
paymentTermsstring | nullrequired
lienHoldersarray of stringrequired
warningobjectrequired
6 schema notes
  • $.payMethod refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.paymentTerms refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lienHolders[] refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.warning.jointCheckWith refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.warning.payMethod refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.warning.paymentTerms refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"payMethod":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"paymentTerms":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"lienHolders":{"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"warning":{"type":"object","properties":{"jointCheckWith":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"payMethod":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"paymentTerms":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},"required":["jointCheckWith","payMethod","paymentTerms"],"additionalProperties":false}},"required":["payMethod","paymentTerms","lienHolders","warning"],"additionalProperties":false}
grain.growerTicketBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealerstring (uuid)required
contractIdstring (uuid)required
ticketIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"dealer":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealer","contractId","ticketId"],"additionalProperties":false}

Output shape documented

FieldLogical typePresence
idstring (uuid)required
ticketNostringrequired
contractIdstring (uuid)required
enteredOnCalendarDayrequired
netBunumberrequired
settleBunumberrequired
ownSharePctnumberrequired
ownBunumberrequired
ownMoneyobject | object | objectrequired
4 schema notes
  • $.netBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.settleBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ownSharePct refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ownBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ticketNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"enteredOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"netBu":{"type":"number","minimum":0,"maximum":100000000},"settleBu":{"type":"number","minimum":0,"maximum":100000000},"ownSharePct":{"type":"number","minimum":0,"maximum":100},"ownBu":{"type":"number","minimum":0,"maximum":100000000},"ownMoney":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"basis":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"queued"},"queuedOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","queuedOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"posting"}},"required":["kind"],"additionalProperties":false}]}},"required":["kind","amount","basis"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unpriced"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","reason"],"additionalProperties":false}]}},"required":["id","ticketNo","contractId","enteredOn","netBu","settleBu","ownSharePct","ownBu","ownMoney"],"additionalProperties":false}
grain.growerTicketsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealerstring (uuid)required
contractIdstring (uuid)may be omitted
Full logical schema
{"type":"object","properties":{"dealer":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealer"],"additionalProperties":false}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
totalintegerrequired
nextCursorstring | nullrequired
4 schema notes
  • $.rows[].netBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].settleBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].ownSharePct refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].ownBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ticketNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"enteredOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"netBu":{"type":"number","minimum":0,"maximum":100000000},"settleBu":{"type":"number","minimum":0,"maximum":100000000},"ownSharePct":{"type":"number","minimum":0,"maximum":100},"ownBu":{"type":"number","minimum":0,"maximum":100000000},"ownMoney":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"basis":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"queued"},"queuedOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","queuedOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"posting"}},"required":["kind"],"additionalProperties":false}]}},"required":["kind","amount","basis"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unpriced"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","reason"],"additionalProperties":false}]}},"required":["id","ticketNo","contractId","enteredOn","netBu","settleBu","ownSharePct","ownBu","ownMoney"],"additionalProperties":false}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["rows","total","nextCursor"],"additionalProperties":false}
grain.issueStatementBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
ticketIdsarray of string (uuid)required
sentVia"Print" | "E-sign"required
Full logical schema
{"type":"object","properties":{"ticketIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"minItems":1},"sentVia":{"type":"string","enum":["Print","E-sign"]}},"required":["ticketIds","sentVia"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"statementId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["statementId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"mixed_payees"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.liensBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
Full logical schema
{"type":"object","properties":{}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
accountsarray of objectrequired
todayCalendarDayrequired
recordLienobject | objectrequired
8 schema notes
  • $.rows[].account refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].lienHolder refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.accounts[].account refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.accounts[].paysBy refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.accounts[].terms refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.accounts[].liens refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.accounts[].activeHolders[] refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.accounts[].edit.paymentTerms refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"lienId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lienNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"account":{"type":"string","minLength":1,"maxLength":200},"lienHolder":{"type":"string","minLength":1,"maxLength":200},"lienKind":{"type":"string","enum":["UCC-1 crop lien","CCC marketing loan"]},"lienAmount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"filedOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"status":{"type":"string","enum":["active","released"]},"releasedOn":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"verdicts":{"type":"object","properties":{"release":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]}},"required":["release"],"additionalProperties":false}},"required":["lienId","lienNo","accountId","account","lienHolder","lienKind","lienAmount","filedOn","status","releasedOn","verdicts"],"additionalProperties":false}},"accounts":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"account":{"type":"string","minLength":1,"maxLength":200},"paysBy":{"type":"string","minLength":1,"maxLength":200},"terms":{"type":"string","minLength":1,"maxLength":200},"liens":{"type":"string","minLength":1,"maxLength":200},"activeHolders":{"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"edit":{"type":"object","properties":{"verdict":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]},"payMethod":{"type":"string","enum":["ACH","Check"]},"paymentTerms":{"type":"string","minLength":1,"maxLength":200}},"required":["verdict","payMethod","paymentTerms"],"additionalProperties":false}},"required":["accountId","account","paysBy","terms","liens","activeHolders","edit"],"additionalProperties":false}},"today":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"recordLien":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]}},"required":["rows","accounts","today","recordLien"],"additionalProperties":false}
grain.locationSearchFind grain location references. UI supported

Input shape documented

FieldLogical typePresence
querystringrequired
1 schema note
  • $.query refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"query":{"type":"string","minLength":1,"maxLength":200}},"required":["query"]}

Output shape documented

array of object | object

Full logical schema
{"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"operated"},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","elevatorId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"network"},"locationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","locationId"],"additionalProperties":false}]}}
grain.moveGrainBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
binIdstring (uuid)required
toBinIdstring (uuid)required
moveBunumberrequired
1 schema note
  • $.moveBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"binId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"toBinId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"moveBu":{"type":"number","minimum":0,"maximum":100000000}},"required":["binId","toBinId","moveBu"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"movementId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["movementId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"bin_removed"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"same_bin"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"insufficient_on_hand"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"other_elevator"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_bushels"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"bin_over_capacity"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"empty_bin"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.newGrainContractBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
sellerstring (uuid)may be omitted
Full logical schema
{"type":"object","properties":{"seller":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
accountsarray of objectrequired
elevatorsarray of objectrequired
buyersarray of objectrequired
bookstring | nullrequired
createContractobject | objectrequired
saveTargetOrderobject | objectrequired
sendContractobject | objectrequired
sendSaleContractobject | objectrequired
7 schema notes
  • $.rows[].account refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].elevator refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.accounts[].name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.elevators[].name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.elevators[].city refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.buyers[].name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"status":{"type":"string","enum":["awaiting-sig","signed","active","expired","filled","stored","cancelled","bought out"]},"account":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"bushels":{"type":"number","minimum":0,"maximum":100000000},"elevator":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"jointCheck":{"anyOf":[{"type":"integer","minimum":0,"maximum":1},{"type":"null"}]},"needsDeferralDisclosure":{"anyOf":[{"type":"integer","minimum":0,"maximum":1},{"type":"null"}]},"send":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]}},"required":["contractId","contractNo","status","account","crop","bushels","elevator","jointCheck","needsDeferralDisclosure","send"],"additionalProperties":false}},"accounts":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":200}},"required":["accountId","name"],"additionalProperties":false}},"elevators":{"type":"array","items":{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":200},"city":{"type":"string","minLength":1,"maxLength":200},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]}},"required":["elevatorId","name","city","state"],"additionalProperties":false}},"buyers":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":200},"buyerType":{"type":"string","enum":["Processor","Ethanol","Feed mill","Exporter","Terminal"]},"destination":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"paymentTerms":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]}},"required":["accountId","name","buyerType","destination","paymentTerms"],"additionalProperties":false}},"book":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"createContract":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]},"saveTargetOrder":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]},"sendContract":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]},"sendSaleContract":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]}},"required":["rows","accounts","elevators","buyers","book","createContract","saveTargetOrder","sendContract","sendSaleContract"],"additionalProperties":false}
grain.notifyOfferBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
offerIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"offerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["offerId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"notificationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["notificationId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"offer_not_near"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"offer_already_notified"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.offerBoardBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
limitintegermay be omitted
cursorstring | nullmay be omitted
tab"all" | "triggered today" | "near" | "working" | "expired" | "cancelled"may be omitted
matchobject | objectmay be omitted
book"mine" | "all"may be omitted
sort"closest to trigger" | "most bushels" | "target month soonest" | "newest"may be omitted
8 schema notes
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tab runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.match|1.q refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.match runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.book runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sort runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":200},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"tab":{"type":"string","enum":["all","triggered today","near","working","expired","cancelled"]},"match":{"oneOf":[{"type":"object","properties":{"by":{"type":"string","const":"none"}},"required":["by"]},{"type":"object","properties":{"by":{"type":"string","const":"text"},"q":{"type":"string","minLength":1}},"required":["by","q"]}]},"book":{"type":"string","enum":["mine","all"]},"sort":{"type":"string","enum":["closest to trigger","most bushels","target month soonest","newest"]}}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
totalintegerrequired
nextCursorstring | nullrequired
facetsobjectrequired
totalsobjectrequired
33 schema notes
  • $.rows[].statusLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].grower refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].cropLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].offerBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].grade refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].terms refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].elevator refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].targetPrice refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].targetLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].basisTarget refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].filledPrice refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].away refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].noteText refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].notifyBrief.title refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].notifyBrief.subtitle refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].notifyBrief.lead refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].notifyBrief.script[] refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].loggedBy refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].comment runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.totals.corn.month refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.totals.corn.last refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.totals.corn.change refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.totals.corn.changeText refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.totals.soybeans.month refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.totals.soybeans.last refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.totals.soybeans.change refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.totals.soybeans.changeText refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.totals.wheat.month refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.totals.wheat.last refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.totals.wheat.change refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.totals.wheat.changeText refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.totals.localCornBasis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"offerNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"status":{"type":"string","enum":["working","near","expired","cancelled","triggered"]},"statusLabel":{"type":"string","minLength":1,"maxLength":200},"grower":{"type":"string","minLength":1,"maxLength":200},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"cropLabel":{"type":"string","minLength":1,"maxLength":200},"offerType":{"type":"string","enum":["Cash","Flat","HTA","Basis"]},"offerBu":{"type":"number","minimum":0,"maximum":100000000},"grade":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"duration":{"type":"string","enum":["GTC","Day"]},"futuresMonth":{"type":"string","minLength":1,"maxLength":200},"terms":{"type":"string","minLength":1,"maxLength":200},"elevator":{"type":"string","minLength":1,"maxLength":200},"targetPrice":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"targetLabel":{"type":"string","minLength":1,"maxLength":200},"basisTarget":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"expiration":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"filledPrice":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"market":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"away":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"proximity":{"anyOf":[{"type":"number","minimum":0,"maximum":1},{"type":"null"}]},"note":{"anyOf":[{"type":"string","enum":["extremely close","close","expired"]},{"type":"null"}]},"noteText":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"contractNo":{"anyOf":[{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},{"type":"null"}]},"contractId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"notified":{"type":"boolean"},"notifyBrief":{"anyOf":[{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":200},"subtitle":{"type":"string","minLength":1,"maxLength":200},"lead":{"type":"string","minLength":1,"maxLength":200},"script":{"type":"array","items":{"type":"string","minLength":1,"maxLength":200},"minItems":1,"maxItems":8}},"required":["title","subtitle","lead","script"],"additionalProperties":false},{"type":"null"}]},"loggedBy":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"accountSplit":{"anyOf":[{"type":"string","enum":["Operating account","Landlord split account","Trust account"]},{"type":"null"}]},"deliveryStart":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"deliveryEnd":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"receivedVia":{"anyOf":[{"type":"string","enum":["Phone","Text","Email","In person"]},{"type":"null"}]},"comment":{"type":"string","maxLength":5000},"cancel":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","const":"offer_expired"}},"required":["status","error"],"additionalProperties":false}]},"notify":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","const":"offer_already_notified"}},"required":["status","error"],"additionalProperties":false}]}},"required":["id","offerNo","status","statusLabel","grower","crop","cropLabel","offerType","offerBu","grade","duration","futuresMonth","terms","elevator","targetPrice","targetLabel","basisTarget","expiration","filledPrice","market","away","proximity","note","noteText","contractNo","contractId","notified","notifyBrief","loggedBy","accountSplit","deliveryStart","deliveryEnd","receivedVia","comment","cancel","notify"],"additionalProperties":false}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"facets":{"type":"object","properties":{"all":{"type":"integer","minimum":0,"maximum":9007199254740991},"triggeredToday":{"type":"integer","minimum":0,"maximum":9007199254740991},"near":{"type":"integer","minimum":0,"maximum":9007199254740991},"working":{"type":"integer","minimum":0,"maximum":9007199254740991},"expired":{"type":"integer","minimum":0,"maximum":9007199254740991},"cancelled":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["all","triggeredToday","near","working","expired","cancelled"],"additionalProperties":false},"totals":{"type":"object","properties":{"corn":{"type":"object","properties":{"month":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"last":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"change":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"changeText":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},"required":["month","last","change","changeText"],"additionalProperties":false},"soybeans":{"type":"object","properties":{"month":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"last":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"change":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"changeText":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},"required":["month","last","change","changeText"],"additionalProperties":false},"wheat":{"type":"object","properties":{"month":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"last":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"change":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"changeText":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},"required":["month","last","change","changeText"],"additionalProperties":false},"localCornBasis":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"localCornBasisTrend":{"anyOf":[{"type":"string","enum":["improving","weakening","unchanged"]},{"type":"null"}]}},"required":["corn","soybeans","wheat","localCornBasis","localCornBasisTrend"],"additionalProperties":false}},"required":["rows","total","nextCursor","facets","totals"],"additionalProperties":false}
grain.payServiceBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
serviceIdstring (uuid)required
payMethod"Check" | "ACH" | "Credit card" | "Cash"required
amountReceivedinteger (money)required
dateReceivedCalendarDayrequired
payRefstringmay be omitted
2 schema notes
  • $.amountReceived refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.payRef refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"serviceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"payMethod":{"type":"string","enum":["Check","ACH","Credit card","Cash"]},"amountReceived":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"dateReceived":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"payRef":{"type":"string","minLength":1,"maxLength":200}},"required":["serviceId","payMethod","amountReceived","dateReceived"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"serviceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["serviceId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_invoiced"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.priceOffersBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
Full logical schema
{"type":"object","properties":{}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
accountsarray of objectrequired
elevatorsarray of objectrequired
htaExpirationCalendarDayrequired
logOfferobject | objectrequired
8 schema notes
  • $.rows[].account refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].offerBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].targetPrice refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].elevator refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].basisTarget refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.accounts[].name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.elevators[].name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"offerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"offerNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"status":{"type":"string","enum":["working","near","expired","cancelled","triggered"]},"account":{"type":"string","minLength":1,"maxLength":200},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"offerBu":{"type":"number","minimum":0,"maximum":100000000},"targetPrice":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"futuresMonth":{"type":"string","minLength":1,"maxLength":200},"elevator":{"type":"string","minLength":1,"maxLength":200},"offerType":{"type":"string","enum":["Cash","Flat","HTA","Basis"]},"duration":{"type":"string","enum":["GTC","Day"]},"expiration":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"basisTarget":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"cancel":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","const":"offer_expired"}},"required":["status","error"],"additionalProperties":false}]},"notify":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","const":"offer_already_notified"}},"required":["status","error"],"additionalProperties":false}]}},"required":["offerId","offerNo","status","account","crop","offerBu","targetPrice","futuresMonth","elevator","offerType","duration","expiration","basisTarget","cancel","notify"],"additionalProperties":false}},"accounts":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":200}},"required":["accountId","name"],"additionalProperties":false}},"elevators":{"type":"array","items":{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":200}},"required":["elevatorId","name"],"additionalProperties":false}},"htaExpiration":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"logOffer":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]}},"required":["rows","accounts","elevators","htaExpiration","logOffer"],"additionalProperties":false}
grain.pullBackBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
ticketIdstring (uuid)required
reasonstringrequired
1 schema note
  • $.reason refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reason":{"type":"string","minLength":1,"maxLength":200}},"required":["ticketId","reason"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["ticketId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_settlement"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.queueBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
queuedOnCalendarDayrequired
ticketIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"queuedOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["queuedOn","ticketId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["ticketId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_applied"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"queued_before_applied"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_priced"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"payable_negative"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.recordLienBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
lienHolderstringrequired
lienKind"UCC-1 crop lien" | "CCC marketing loan"required
lienAmountinteger (money) | nullrequired
filedOnCalendarDayrequired
3 schema notes
  • $.lienHolder refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lienHolder runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lienAmount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lienHolder":{"type":"string","minLength":2,"maxLength":200},"lienKind":{"type":"string","enum":["UCC-1 crop lien","CCC marketing loan"]},"lienAmount":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"filedOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["accountId","lienHolder","lienKind","lienAmount","filedOn"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"lienId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["lienId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"lien_holder_active"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.recordServiceBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
serviceIdstring (uuid)required
wetBushelsnumberrequired
moistureInnumberrequired
moistureOutnumberrequired
3 schema notes
  • $.wetBushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.moistureIn refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.moistureOut refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"serviceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"wetBushels":{"type":"number","minimum":0,"maximum":1000000},"moistureIn":{"type":"number","minimum":0,"maximum":100},"moistureOut":{"type":"number","minimum":0,"maximum":100}},"required":["serviceId","wetBushels","moistureIn","moistureOut"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"serviceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["serviceId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_scheduled"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.releaseBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
lienIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"lienId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["lienId"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"lienId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["lienId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_active","no_company"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.removeBinBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
binIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"binId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["binId"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"binId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["binId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_active"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.retireElevatorBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
elevatorIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["elevatorId"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["elevatorId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_elevator","bins_hold_grain","open_commitments"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.retryEnvelopeBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
envelopeIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"envelopeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["envelopeId"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"envelopeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["envelopeId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_failed"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_retryable"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"record_closed"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_email"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unprintable"},"characters":{"type":"array","items":{"type":"string"},"minItems":1}},"required":["code","characters"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.saleContractPageBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
saleContractIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"saleContractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["saleContractId"]}

Output shape documented

FieldLogical typePresence
saleobject | nullrequired
9 schema notes
  • $.sale.buyer refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sale.shipFrom refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sale.statusLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sale.gradeCommitted refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sale.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sale.price refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sale.futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sale.shipMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sale.shipMonthLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"sale":{"anyOf":[{"type":"object","properties":{"saleContractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"buyerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"buyer":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"shipFrom":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"status":{"type":"string","enum":["awaiting-sig","signed","active","expired","filled","stored","cancelled","bought out"]},"statusLabel":{"type":"string","minLength":1,"maxLength":200},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"gradeCommitted":{"type":"string","minLength":1,"maxLength":200},"bushels":{"type":"number","minimum":0,"maximum":10000000},"contractType":{"type":"string","enum":["full priced","futures only","basis only"]},"price":{"type":"string","minLength":1,"maxLength":200},"futuresMonth":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"shipMonth":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"shipMonthLabel":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},"required":["saleContractId","contractNo","buyerId","buyer","shipFrom","status","statusLabel","crop","gradeCommitted","bushels","contractType","price","futuresMonth","shipMonth","shipMonthLabel"],"additionalProperties":false},{"type":"null"}]}},"required":["sale"],"additionalProperties":false}
grain.saveTargetBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
crop"Corn" | "Soybeans" | "Wheat" | "Sorghum" | "Barley" | "Oats" | "Rye" | "Canola" | "Sunflower"required
bushelsnumberrequired
elevatorIdstring (uuid)required
contractType"full priced" | "futures only" | "basis only" | "delayed price"required
futuresMonthstringrequired
gradeCommittedstringmay be omitted
targetKind"cash" | "futures only" | "basis only"may be omitted
targetPriceUnitPricemay be omitted
basisTargetUnitPricemay be omitted
orderDuration"good till cancelled" | "good for the day"may be omitted
expiresCalendarDaymay be omitted
priceMode"price now" | "set target"required
5 schema notes
  • $.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.gradeCommitted refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.targetPrice refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.basisTarget refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"bushels":{"type":"number","minimum":0,"maximum":100000000},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractType":{"type":"string","enum":["full priced","futures only","basis only","delayed price"]},"futuresMonth":{"type":"string","minLength":1,"maxLength":200},"gradeCommitted":{"type":"string","minLength":1,"maxLength":200},"targetKind":{"type":"string","enum":["cash","futures only","basis only"]},"targetPrice":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"basisTarget":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"orderDuration":{"type":"string","enum":["good till cancelled","good for the day"]},"expires":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"priceMode":{"type":"string","enum":["price now","set target"]}},"required":["accountId","crop","bushels","elevatorId","contractType","futuresMonth","priceMode"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"offerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["offerId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_set_target"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"target_terms_missing"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"target_not_positive"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"target_terms_contradict"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.scaleTicketBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
ticketIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["ticketId"]}

Output shape documented

FieldLogical typePresence
ticketobject | nullrequired
55 schema notes
  • $.ticket.grossLb refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.tareLb refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.netLb refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.netBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.lbPerBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.elevator refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.cropShort refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.gradeShort refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.cropGrade refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.readings[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.readings[].abbrev refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.readings[].value refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.readings[].valueText refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.readings[].standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.gradeAlert.reason refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|0.netBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|0.shrinkPct refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|0.dryBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|0.dockagePct refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|0.settleBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|0.moistureCap refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|0.overBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|0.onContractBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|0.price.price refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|0.spotPrice refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|0.offGrade[] refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|0.money.pointsOver refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|0.money.ratePerPoint refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|0.money.discountPerBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|0.money.deductions[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|0.parties[].sharePct refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|0.parties[].bu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|0.parties[].name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|1.netBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|1.settleBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|1.overBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|1.onContractBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|1.lines[].bu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|1.lines[].price refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|1.overage.bu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|1.overage.price refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|1.money.deductions[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|1.parties[].sharePct refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|1.parties[].bu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.settlement|1.parties[].name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.fill.filledBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.fill.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.grower.name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.grower.region refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.grower.subject|2.compassCompanyUid runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.options[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.allocations[].bu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.allocate[].price refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.allocate[].bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.ticket.allocate[].roomBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"ticket":{"anyOf":[{"type":"object","properties":{"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ticketNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"day":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"status":{"type":"string","enum":["entered","applied","settlement","settled","deliverySettled"]},"statusWord":{"type":"string","enum":["entered","applied","in settlement","settled"]},"grossLb":{"type":"number","minimum":0,"maximum":200000},"tareLb":{"type":"number","minimum":0,"maximum":200000},"netLb":{"type":"number","minimum":0,"maximum":200000},"netBu":{"type":"number","minimum":0,"maximum":100000000},"lbPerBu":{"type":"number","minimum":0,"maximum":200000},"elevator":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"cropShort":{"type":"string","minLength":1,"maxLength":200},"gradeShort":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"cropGrade":{"type":"string","minLength":1,"maxLength":200},"readings":{"type":"array","items":{"type":"object","properties":{"reading":{"type":"string","enum":["testWeight","moisture","fm","bcfm","damage","heatDamage","splits","protein","dockage"]},"label":{"type":"string","minLength":1,"maxLength":200},"abbrev":{"type":"string","minLength":1,"maxLength":200},"value":{"anyOf":[{"type":"number","minimum":0,"maximum":100},{"type":"null"}]},"valueText":{"type":"string","minLength":1,"maxLength":200},"standard":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"offGrade":{"type":"boolean"}},"required":["reading","label","abbrev","value","valueText","standard","offGrade"],"additionalProperties":false}},"gradeAlert":{"type":"object","properties":{"level":{"type":"integer","minimum":0,"maximum":2},"reason":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},"required":["level","reason"],"additionalProperties":false},"settlement":{"oneOf":[{"type":"object","properties":{"netBu":{"type":"number","minimum":0,"maximum":100000000},"shrinkPct":{"type":"number","minimum":0,"maximum":100},"dryBu":{"type":"number","minimum":0,"maximum":100000000},"dockagePct":{"type":"number","minimum":0,"maximum":100},"settleBu":{"type":"number","minimum":0,"maximum":100000000},"moistureCap":{"type":"number","minimum":0,"maximum":100},"overMoistureCap":{"type":"boolean"},"overBu":{"type":"number","minimum":0,"maximum":100000000},"onContractBu":{"type":"number","minimum":0,"maximum":100000000},"price":{"anyOf":[{"type":"object","properties":{"price":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"kind":{"type":"string","enum":["flat","local cash bid"]}},"required":["price","kind"],"additionalProperties":false},{"type":"null"}]},"spotPrice":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"offGrade":{"type":"array","items":{"type":"string","minLength":1,"maxLength":200}},"money":{"anyOf":[{"type":"object","properties":{"onContract":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"over":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"gross":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"drying":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"pointsOver":{"type":"number","minimum":0,"maximum":100},"ratePerPoint":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"discountPerBu":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"gradeDiscount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"deductions":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["checkoff","indemnity","inspection","storage","freight","advance"]},"label":{"type":"string","minLength":1,"maxLength":200},"charge":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","label","charge"],"additionalProperties":false}},"rejected":{"type":"boolean"},"netToGrower":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["onContract","over","gross","drying","pointsOver","ratePerPoint","discountPerBu","gradeDiscount","deductions","rejected","netToGrower"],"additionalProperties":false},{"type":"null"}]},"parties":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sharePct":{"type":"number","minimum":0,"maximum":100},"bu":{"type":"number","minimum":0,"maximum":100000000},"net":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"name":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},"required":["accountId","sharePct","bu","net","name"],"additionalProperties":false}},"kind":{"type":"string","const":"preview"}},"required":["netBu","shrinkPct","dryBu","dockagePct","settleBu","moistureCap","overMoistureCap","overBu","onContractBu","price","spotPrice","offGrade","money","parties","kind"],"additionalProperties":false},{"type":"object","properties":{"netBu":{"type":"number","minimum":0,"maximum":100000000},"settleBu":{"type":"number","minimum":0,"maximum":100000000},"overBu":{"type":"number","minimum":0,"maximum":100000000},"onContractBu":{"type":"number","minimum":0,"maximum":100000000},"lines":{"type":"array","items":{"type":"object","properties":{"bu":{"type":"number","minimum":0,"maximum":100000000},"price":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"gross":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["bu","price","gross"],"additionalProperties":false}},"overage":{"anyOf":[{"type":"object","properties":{"bu":{"type":"number","minimum":0,"maximum":100000000},"price":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"gross":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["bu","price","gross"],"additionalProperties":false},{"type":"null"}]},"money":{"anyOf":[{"type":"object","properties":{"onContract":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"over":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"gross":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"drying":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"deductions":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["checkoff","indemnity","inspection","storage","freight","advance"]},"label":{"type":"string","minLength":1,"maxLength":200},"charge":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","label","charge"],"additionalProperties":false}},"rejected":{"type":"boolean"},"netToGrower":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]}},"required":["onContract","over","gross","drying","deductions","rejected","netToGrower"],"additionalProperties":false},{"type":"null"}]},"parties":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sharePct":{"type":"number","minimum":0,"maximum":100},"bu":{"type":"number","minimum":0,"maximum":100000000},"net":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"name":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},"required":["accountId","sharePct","bu","net","name"],"additionalProperties":false}},"kind":{"type":"string","const":"posted"}},"required":["netBu","settleBu","overBu","onContractBu","lines","overage","money","parties","kind"],"additionalProperties":false}]},"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"fill":{"type":"object","properties":{"filledBu":{"type":"number","minimum":0,"maximum":100000000},"bushels":{"type":"number","minimum":0,"maximum":100000000}},"required":["filledBu","bushels"],"additionalProperties":false},"grower":{"anyOf":[{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":200},"region":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"subject":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"farm"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"company"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","companyId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"manufacturer"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"compassCompanyUid":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["kind","companyId","compassCompanyUid"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"distributor"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","companyId"],"additionalProperties":false}]},"open":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]}},"required":["accountId","name","region","subject","open"],"additionalProperties":false},{"type":"null"}]},"pick":{"type":"string","enum":["apply","unapply","locked"]},"options":{"type":"array","items":{"type":"object","properties":{"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"label":{"type":"string","minLength":1,"maxLength":200},"verdict":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"current":{"type":"boolean"}},"required":["contractId","contractNo","label","verdict","current"],"additionalProperties":false}},"allocations":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"bu":{"type":"number","minimum":0,"maximum":100000000}},"required":["contractId","contractNo","bu"],"additionalProperties":false}},{"type":"null"}]},"allocate":{"type":"array","items":{"type":"object","properties":{"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"price":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"bushels":{"type":"number","minimum":0,"maximum":100000000},"roomBu":{"type":"number","minimum":0,"maximum":100000000},"verdict":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]}},"required":["contractId","contractNo","price","bushels","roomBu","verdict"],"additionalProperties":false}},"verdicts":{"type":"object","properties":{"apply":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"settleDelivery":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"unapply":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"queue":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"pullBack":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"settle":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["apply","settleDelivery","unapply","queue","pullBack","settle"],"additionalProperties":false},"today":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["ticketId","ticketNo","day","status","statusWord","grossLb","tareLb","netLb","netBu","lbPerBu","elevator","crop","cropShort","gradeShort","cropGrade","readings","gradeAlert","settlement","contractId","contractNo","fill","grower","pick","options","allocations","allocate","verdicts","today"],"additionalProperties":false},{"type":"null"}]}},"required":["ticket"],"additionalProperties":false}
grain.scaleTicketsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
limitintegermay be omitted
cursorstring | nullmay be omitted
status"all" | "entered" | "applied" | "in settlement" | "settled"may be omitted
commodity"all" | "Corn" | "Soybeans" | "Wheat" | "Sorghum"may be omitted
sort"by status" | "newest"may be omitted
6 schema notes
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.status runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.commodity runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sort runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":200},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"status":{"type":"string","enum":["all","entered","applied","in settlement","settled"]},"commodity":{"type":"string","enum":["all","Corn","Soybeans","Wheat","Sorghum"]},"sort":{"type":"string","enum":["by status","newest"]}}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
totalintegerrequired
nextCursorstring | nullrequired
facetsobjectrequired
totalsobjectrequired
26 schema notes
  • $.rows[].crop refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].grade refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].farmer refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].contractLine refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].split refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].mode refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].netBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].testWeight.text refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].testWeight.standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].moisture.text refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].moisture.standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].fm.text refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].fm.standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].bcfm.text refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].bcfm.standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].damage.text refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].damage.standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].heatDamage.text refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].heatDamage.standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].splits.text refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].splits.standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].protein.text refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].protein.standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].dockage.text refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].dockage.standard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].destination refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ticketNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"day":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"crop":{"type":"string","minLength":1,"maxLength":200},"grade":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"farmer":{"type":"string","minLength":1,"maxLength":200},"contractLine":{"type":"string","minLength":1,"maxLength":200},"contractNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"split":{"type":"string","minLength":1,"maxLength":200},"dealType":{"type":"string","enum":["origination","direct-ship","storage / DP"]},"mode":{"type":"string","minLength":1,"maxLength":200},"netBu":{"type":"number","minimum":0,"maximum":100000000},"testWeight":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":200},"standard":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"offGrade":{"type":"boolean"}},"required":["text","standard","offGrade"],"additionalProperties":false},{"type":"null"}]},"moisture":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":200},"standard":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"offGrade":{"type":"boolean"}},"required":["text","standard","offGrade"],"additionalProperties":false},{"type":"null"}]},"fm":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":200},"standard":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"offGrade":{"type":"boolean"}},"required":["text","standard","offGrade"],"additionalProperties":false},{"type":"null"}]},"bcfm":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":200},"standard":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"offGrade":{"type":"boolean"}},"required":["text","standard","offGrade"],"additionalProperties":false},{"type":"null"}]},"damage":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":200},"standard":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"offGrade":{"type":"boolean"}},"required":["text","standard","offGrade"],"additionalProperties":false},{"type":"null"}]},"heatDamage":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":200},"standard":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"offGrade":{"type":"boolean"}},"required":["text","standard","offGrade"],"additionalProperties":false},{"type":"null"}]},"splits":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":200},"standard":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"offGrade":{"type":"boolean"}},"required":["text","standard","offGrade"],"additionalProperties":false},{"type":"null"}]},"protein":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":200},"standard":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"offGrade":{"type":"boolean"}},"required":["text","standard","offGrade"],"additionalProperties":false},{"type":"null"}]},"dockage":{"anyOf":[{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":200},"standard":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"offGrade":{"type":"boolean"}},"required":["text","standard","offGrade"],"additionalProperties":false},{"type":"null"}]},"destination":{"type":"string","minLength":1,"maxLength":200},"status":{"type":"string","enum":["entered","applied","in settlement","settled"]},"alert":{"anyOf":[{"type":"string","enum":["off-grade","rejected"]},{"type":"null"}]}},"required":["id","ticketNo","day","crop","grade","farmer","contractLine","contractNo","split","dealType","mode","netBu","testWeight","moisture","fm","bcfm","damage","heatDamage","splits","protein","dockage","destination","status","alert"],"additionalProperties":false}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"facets":{"type":"object","properties":{"all":{"type":"integer","minimum":0,"maximum":9007199254740991},"entered":{"type":"integer","minimum":0,"maximum":9007199254740991},"applied":{"type":"integer","minimum":0,"maximum":9007199254740991},"inSettlement":{"type":"integer","minimum":0,"maximum":9007199254740991},"settled":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["all","entered","applied","inSettlement","settled"],"additionalProperties":false},"totals":{"type":"object","properties":{"allSettled":{"type":"boolean"}},"required":["allSettled"],"additionalProperties":false}},"required":["rows","total","nextCursor","facets","totals"],"additionalProperties":false}
grain.scheduleBookingBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
Full logical schema
{"type":"object","properties":{}}

Output shape documented

FieldLogical typePresence
contractsarray of objectrequired
binsarray of objectrequired
todayCalendarDayrequired
defaultsobjectrequired
verdictsobjectrequired
14 schema notes
  • $.contracts[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contracts[].line refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contracts[].split refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contracts[].elevatorName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bins[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bins[].capacityBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bins[].onHandBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bins[].inboundBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bins[].headroomBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bins[].option refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bins[].cropLine refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bins[].binLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bins[].weighLine refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.defaults.time refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"contracts":{"type":"array","items":{"type":"object","properties":{"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1,"maxLength":200},"line":{"type":"string","minLength":1,"maxLength":200},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"split":{"type":"string","minLength":1,"maxLength":200},"elevatorName":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"bins":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"elevatorBins":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["contractId","label","line","crop","split","elevatorName","bins","elevatorBins"],"additionalProperties":false}},"bins":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1,"maxLength":200},"capacityBu":{"type":"number","minimum":0,"maximum":100000000},"onHandBu":{"type":"number","minimum":0,"maximum":100000000},"inboundBu":{"type":"number","minimum":0,"maximum":100000000},"headroomBu":{"type":"number","minimum":0,"maximum":100000000},"contents":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"option":{"type":"string","minLength":1,"maxLength":200},"cropLine":{"type":"string","minLength":1,"maxLength":200},"binLabel":{"type":"string","minLength":1,"maxLength":200},"weighLine":{"type":"string","minLength":1,"maxLength":200}},"required":["id","label","capacityBu","onHandBu","inboundBu","headroomBu","contents","option","cropLine","binLabel","weighLine"],"additionalProperties":false}},"today":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"defaults":{"type":"object","properties":{"contractId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"bin":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"time":{"type":"string","minLength":1,"maxLength":200}},"required":["contractId","bin","time"],"additionalProperties":false},"verdicts":{"type":"object","properties":{"scheduleDelivery":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]},"enterWalkInTicket":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]}},"required":["scheduleDelivery","enterWalkInTicket"],"additionalProperties":false}},"required":["contracts","bins","today","defaults","verdicts"],"additionalProperties":false}
grain.scheduleDeliveryBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
contractIdstring (uuid)required
binstring (uuid) | stringrequired
deliveryDateCalendarDayrequired
timestringrequired
truckstringrequired
loadBunumberrequired
4 schema notes
  • $.bin|1 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.time refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.truck refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.loadBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"bin":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","minLength":1,"maxLength":200}]},"deliveryDate":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"time":{"type":"string","minLength":1,"maxLength":200},"truck":{"type":"string","minLength":1,"maxLength":200},"loadBu":{"type":"number","minimum":0,"maximum":100000000}},"required":["contractId","bin","deliveryDate","time","truck","loadBu"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"slotId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["slotId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"contract_not_open"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"bin_over_capacity"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"bin_not_offered"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.scheduleServiceBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
serviceIdstring (uuid)required
serviceDateCalendarDayrequired
elevatorIdstring (uuid)required
time"7:00 AM" | "8:00 AM" | "9:30 AM" | "11:00 AM" | "1:15 PM" | "2:30 PM" | "4:00 PM"required
truckstringmay be omitted
1 schema note
  • $.truck refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"serviceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"serviceDate":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"time":{"type":"string","enum":["7:00 AM","8:00 AM","9:30 AM","11:00 AM","1:15 PM","2:30 PM","4:00 PM"]},"truck":{"type":"string","minLength":1,"maxLength":200}},"required":["serviceId","serviceDate","elevatorId","time"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"serviceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["serviceId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_signed"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.sellFromStorageBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
receiptIdstring (uuid)required
sellBunumberrequired
cashPriceUnitPricerequired
2 schema notes
  • $.sellBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cashPrice refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"receiptId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sellBu":{"type":"number","minimum":0,"maximum":10000000},"cashPrice":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"}},"required":["receiptId","sellBu","cashPrice"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"receiptSaleId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["receiptSaleId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"receipt_closed"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"sell_over_remaining"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.sendAgreementBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
serviceIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"serviceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["serviceId"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"serviceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"envelopeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["serviceId","envelopeId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_draft"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_email"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unprintable"},"characters":{"type":"array","items":{"type":"string"},"minItems":1}},"required":["code","characters"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.sendContractBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
contractIdstring (uuid)required
sentTostringrequired
1 schema note
  • $.sentTo refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sentTo":{"type":"string","minLength":1,"maxLength":200}},"required":["contractId","sentTo"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"envelopeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["envelopeId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_awaiting_sig"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_email"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unprintable"},"characters":{"type":"array","items":{"type":"string"},"minItems":1}},"required":["code","characters"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"already_sent"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.sendNewContractBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
growerIdstring (uuid)required
dealType"origination" | "direct-ship" | "storage / DP"required
crop"Corn" | "Soybeans" | "Wheat" | "Sorghum" | "Barley" | "Oats" | "Rye" | "Canola" | "Sunflower"required
cropClassstringmay be omitted
gradeCommittedstringmay be omitted
bushelsnumberrequired
elevatorIdstring (uuid)required
priceMode"price now" | "set target"required
contractType"full priced" | "futures only" | "basis only" | "delayed price"required
premiumsPickedarray of objectmay be omitted
futuresMonthstringmay be omitted
dpBasisUnitPricemay be omitted
deliveryMonthstringmay be omitted
targetStartCalendarDaymay be omitted
targetEndCalendarDaymay be omitted
counterpartiesarray of objectmay be omitted
sentTostringrequired
13 schema notes
  • $.cropClass refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.gradeCommitted refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.premiumsPicked[].premium refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.premiumsPicked[].amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.premiumsPicked runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.dpBasis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.deliveryMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.counterparties refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.counterparties[].sharePct refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.counterparties runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sentTo refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"growerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dealType":{"type":"string","enum":["origination","direct-ship","storage / DP"]},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"cropClass":{"type":"string","minLength":1,"maxLength":200},"gradeCommitted":{"type":"string","minLength":1,"maxLength":200},"bushels":{"type":"number","minimum":0,"maximum":10000000},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priceMode":{"type":"string","enum":["price now","set target"]},"contractType":{"type":"string","enum":["full priced","futures only","basis only","delayed price"]},"premiumsPicked":{"type":"array","items":{"type":"object","properties":{"premium":{"type":"string","minLength":1,"maxLength":200},"amount":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"}},"required":["premium","amount"]}},"futuresMonth":{"type":"string","minLength":1,"maxLength":200},"dpBasis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"deliveryMonth":{"type":"string","minLength":1,"maxLength":200},"targetStart":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"targetEnd":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"counterparties":{"type":"array","items":{"type":"object","properties":{"account":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sharePct":{"type":"number","minimum":0,"maximum":100}},"required":["account","sharePct"]}},"sentTo":{"type":"string","minLength":1,"maxLength":200}},"required":["growerId","dealType","crop","bushels","elevatorId","priceMode","contractType","sentTo"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"envelopeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["contractId","envelopeId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_price_now"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"contract_not_ready"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_awaiting_sig"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_email"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unprintable"},"characters":{"type":"array","items":{"type":"string"},"minItems":1}},"required":["code","characters"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.sendNewSaleContractBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
buyerIdstring (uuid)required
shipFromElevatorIdstring (uuid)required
crop"Corn" | "Soybeans" | "Wheat" | "Sorghum" | "Barley" | "Oats" | "Rye" | "Canola" | "Sunflower"required
cropClassstringmay be omitted
gradeCommittedstringmay be omitted
bushelsnumberrequired
contractType"full priced" | "futures only" | "basis only"required
premiumsPickedarray of objectmay be omitted
futuresMonthstringmay be omitted
shipMonthstringmay be omitted
sentTostringrequired
9 schema notes
  • $.cropClass refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.gradeCommitted refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.premiumsPicked[].premium refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.premiumsPicked[].amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.premiumsPicked runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.shipMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sentTo refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"buyerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"shipFromElevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"cropClass":{"type":"string","minLength":1,"maxLength":200},"gradeCommitted":{"type":"string","minLength":1,"maxLength":200},"bushels":{"type":"number","minimum":0,"maximum":10000000},"contractType":{"type":"string","enum":["full priced","futures only","basis only"]},"premiumsPicked":{"type":"array","items":{"type":"object","properties":{"premium":{"type":"string","minLength":1,"maxLength":200},"amount":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"}},"required":["premium","amount"]}},"futuresMonth":{"type":"string","minLength":1,"maxLength":200},"shipMonth":{"type":"string","minLength":1,"maxLength":200},"sentTo":{"type":"string","minLength":1,"maxLength":200}},"required":["buyerId","shipFromElevatorId","crop","bushels","contractType","sentTo"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"saleContractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"envelopeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["saleContractId","envelopeId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"contract_not_ready"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_awaiting_sig"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_a_buyer"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_email"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unprintable"},"characters":{"type":"array","items":{"type":"string"},"minItems":1}},"required":["code","characters"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.serviceOrderFormBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
Full logical schema
{"type":"object","properties":{}}

Output shape documented

FieldLogical typePresence
growersarray of objectrequired
elevatorsarray of objectrequired
draftServiceobject | objectrequired
2 schema notes
  • $.growers[].name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.elevators[].name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"growers":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":200}},"required":["accountId","name"],"additionalProperties":false}},"elevators":{"type":"array","items":{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":200}},"required":["elevatorId","name"],"additionalProperties":false}},"draftService":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]}},"required":["growers","elevators","draftService"],"additionalProperties":false}
grain.serviceOrderPageBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
serviceIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"serviceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["serviceId"]}

Output shape documented

FieldLogical typePresence
orderobject | nullrequired
16 schema notes
  • $.order.grower refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.order.elevator refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.order.statusLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.order.estBushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.order.estMoisture refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.order.dryTo refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.order.storageMonths refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.order.agreementNote refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.order.appointment.time refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.order.appointment.truck refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.order.actuals.wetBushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.order.actuals.moistureIn refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.order.actuals.moistureOut refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.order.billing.invoice.invoiceNo refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.order.billing.invoice.export.failureReason refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.order.billing.payment.payRef refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"order":{"anyOf":[{"type":"object","properties":{"serviceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"serviceNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"grower":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"elevator":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"today":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"status":{"type":"string","enum":["draft","sent","signed","scheduled","serviced","invoiced","paid"]},"statusLabel":{"type":"string","minLength":1,"maxLength":200},"services":{"type":"array","items":{"type":"string","enum":["Drying","Receiving & handling","Cleaning","Storage","Load-out"]}},"estBushels":{"type":"number","minimum":0,"maximum":100000000},"estMoisture":{"type":"number","minimum":0,"maximum":100},"dryTo":{"type":"string","minLength":1,"maxLength":200},"storageMonths":{"type":"string","minLength":1,"maxLength":200},"agreementNote":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"estimate":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"appointment":{"anyOf":[{"type":"object","properties":{"serviceDate":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"time":{"type":"string","minLength":1,"maxLength":200},"truck":{"type":"string","minLength":1,"maxLength":200}},"required":["serviceDate","time","truck"],"additionalProperties":false},{"type":"null"}]},"actuals":{"anyOf":[{"type":"object","properties":{"wetBushels":{"type":"number","minimum":0,"maximum":100000000},"moistureIn":{"type":"number","minimum":0,"maximum":100},"moistureOut":{"type":"number","minimum":0,"maximum":100},"servicedOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["wetBushels","moistureIn","moistureOut","servicedOn"],"additionalProperties":false},{"type":"null"}]},"billing":{"type":"object","properties":{"ready":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"invoice":{"anyOf":[{"type":"object","properties":{"invoiceNo":{"type":"string","minLength":1,"maxLength":200},"invoiceDate":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"dueDate":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"charges":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"export":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["queued","sent","failed"]},"failureReason":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},"required":["status","failureReason"],"additionalProperties":false},{"type":"null"}]}},"required":["invoiceNo","invoiceDate","dueDate","charges","export"],"additionalProperties":false},{"type":"null"}]},"payment":{"anyOf":[{"type":"object","properties":{"payMethod":{"type":"string","enum":["Check","ACH","Credit card","Cash"]},"payRef":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"amountReceived":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"dateReceived":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["payMethod","payRef","amountReceived","dateReceived"],"additionalProperties":false},{"type":"null"}]}},"required":["ready","invoice","payment"],"additionalProperties":false},"verdicts":{"type":"object","properties":{"sendAgreement":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]},"signAgreement":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]},"scheduleService":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]},"recordService":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]},"invoiceService":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]},"payService":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]}},"required":["sendAgreement","signAgreement","scheduleService","recordService","invoiceService","payService"],"additionalProperties":false}},"required":["serviceId","serviceNo","accountId","grower","elevator","elevatorId","today","crop","status","statusLabel","services","estBushels","estMoisture","dryTo","storageMonths","agreementNote","estimate","appointment","actuals","billing","verdicts"],"additionalProperties":false},{"type":"null"}]}},"required":["order"],"additionalProperties":false}
grain.servicesBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
limitintegermay be omitted
cursorstring | nullmay be omitted
sort"newest"may be omitted
4 schema notes
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sort runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":200},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"sort":{"type":"string","const":"newest"}}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
totalintegerrequired
nextCursorstring | nullrequired
facetsobjectrequired
5 schema notes
  • $.rows[].grower refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].time refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].services refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].statusLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"serviceNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"grower":{"type":"string","minLength":1,"maxLength":200},"serviceDate":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"time":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"bushels":{"type":"number","minimum":0,"maximum":100000000},"actual":{"type":"boolean"},"services":{"type":"string","minLength":1,"maxLength":200},"status":{"type":"string","enum":["draft","sent","signed","scheduled","serviced","invoiced","paid"]},"statusLabel":{"type":"string","minLength":1,"maxLength":200}},"required":["id","serviceNo","grower","serviceDate","time","crop","bushels","actual","services","status","statusLabel"],"additionalProperties":false}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"facets":{"type":"object","properties":{},"additionalProperties":false}},"required":["rows","total","nextCursor","facets"],"additionalProperties":false}
grain.setFreightTermsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
freightPerBuUnitPricerequired
freightPaidBy"Elevator" | "Grower"required
contractIdstring (uuid)required
1 schema note
  • $.freightPerBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"freightPerBu":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"freightPaidBy":{"type":"string","enum":["Elevator","Grower"]},"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["freightPerBu","freightPaidBy","contractId"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["contractId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"contract_not_open"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.settleDeliveryBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
deliveryobject | objectrequired
disposition"Immediate Pay" | "Deferred Payment" | "Warehouse" | "Price Later" | "Grain Bank"required
Full logical schema
{"type":"object","properties":{"delivery":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"group"},"growerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","growerId","crop","elevatorId"]},{"type":"object","properties":{"kind":{"type":"string","const":"alone"},"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","ticketId"]}]},"disposition":{"type":"string","enum":["Immediate Pay","Deferred Payment","Warehouse","Price Later","Grain Bank"]}},"required":["delivery","disposition"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"deliverySettlementId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["deliverySettlementId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"delivery_mismatch"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_priced"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.settlementQueueBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
Full logical schema
{"type":"object","properties":{}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
appliedarray of objectrequired
exportDefaultsobject | nullrequired
exportDefaultsByAccountarray of objectrequired
growersarray of objectrequired
tabsobjectrequired
statsobjectrequired
totalsobjectrequired
todayCalendarDayrequired
issueStatementobject | objectrequired
26 schema notes
  • $.exportDefaults.terms refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.exportDefaultsByAccount[].terms refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].payMethod refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].terms refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].jointPayee refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].crop refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].reviewNote refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].tickets[].crop refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].tickets[].split refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].tickets[].netBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].tickets[].moisture refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].tickets[].scaleNetBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].tickets[].overBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].tickets[].onContractBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].tickets[].parties[].name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].tickets[].parties[].sharePct refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].tickets[].parties[].payMethod refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].tickets[].parties[].bu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].tickets[].money.lines[].bu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].tickets[].money.lines[].price refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].tickets[].money.overage.bu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].tickets[].money.overage.price refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].tickets[].money.gradeDiscount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.growers[].money|0.deductions[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ticketNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"status":{"type":"string","enum":["settlement","sent","cleared"]},"queuedAt":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"payable":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"landlordPays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"growerPays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"batch":{"anyOf":[{"type":"string","pattern":"^B-\\d+$"},{"type":"null"}]},"paidAt":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"verdicts":{"type":"object","properties":{"apply":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"settleDelivery":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"unapply":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"queue":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"pullBack":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"settle":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["apply","settleDelivery","unapply","queue","pullBack","settle"],"additionalProperties":false}},"required":["ticketId","ticketNo","status","queuedAt","payable","landlordPays","growerPays","batch","paidAt","verdicts"],"additionalProperties":false}},"applied":{"type":"array","items":{"type":"object","properties":{"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ticketNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"verdicts":{"type":"object","properties":{"apply":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"settleDelivery":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"unapply":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"queue":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"pullBack":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"settle":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["apply","settleDelivery","unapply","queue","pullBack","settle"],"additionalProperties":false}},"required":["ticketId","ticketNo","verdicts"],"additionalProperties":false}},"exportDefaults":{"anyOf":[{"type":"object","properties":{"payMethod":{"type":"string","enum":["ACH","cheque"]},"terms":{"type":"string","minLength":1,"maxLength":200}},"additionalProperties":false},{"type":"null"}]},"exportDefaultsByAccount":{"type":"array","items":{"type":"object","properties":{"payMethod":{"type":"string","enum":["ACH","cheque"]},"terms":{"type":"string","minLength":1,"maxLength":200},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ticketIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["accountId","ticketIds"],"additionalProperties":false}},"growers":{"type":"array","items":{"type":"object","properties":{"tab":{"type":"string","enum":["ready","review","sent","cleared","direct"]},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"payMethod":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"terms":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"jointPayee":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"ticketCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"bushels":{"type":"number","minimum":0,"maximum":100000000},"crop":{"type":"string","minLength":1,"maxLength":200},"reviewNote":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"tickets":{"type":"array","items":{"type":"object","properties":{"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ticketNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"crop":{"type":"string","minLength":1,"maxLength":200},"contractNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"split":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"netBu":{"type":"number","minimum":0,"maximum":100000000},"moisture":{"type":"number","minimum":0,"maximum":100},"moistureHigh":{"type":"boolean"},"scaleNetBu":{"type":"number","minimum":0,"maximum":100000000},"overBu":{"type":"number","minimum":0,"maximum":100000000},"onContractBu":{"type":"number","minimum":0,"maximum":100000000},"parties":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"sharePct":{"type":"number","minimum":0,"maximum":100},"payMethod":{"type":"string","minLength":1,"maxLength":200},"payable":{"type":"boolean"},"bu":{"type":"number","minimum":0,"maximum":100000000},"gross":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"checkoff":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"net":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]}},"required":["accountId","name","sharePct","payMethod","payable","bu","gross","checkoff","net"],"additionalProperties":false}},"money":{"anyOf":[{"type":"object","properties":{"lines":{"type":"array","items":{"type":"object","properties":{"bu":{"type":"number","minimum":0,"maximum":100000000},"price":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"gross":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["bu","price","gross"],"additionalProperties":false}},"overage":{"anyOf":[{"type":"object","properties":{"bu":{"type":"number","minimum":0,"maximum":100000000},"price":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"gross":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["bu","price","gross"],"additionalProperties":false},{"type":"null"}]},"gradeDiscount":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"gross":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"deductions":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["checkoff","indemnity","inspection","drying","storage","freight"]},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","amount"],"additionalProperties":false}},"payable":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["lines","overage","gradeDiscount","gross","deductions","payable"],"additionalProperties":false},{"type":"null"}]},"verdicts":{"type":"object","properties":{"apply":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"settleDelivery":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"unapply":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"queue":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"pullBack":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]},"settle":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["contract_not_open","grower_mismatch","crop_mismatch","grade_mismatch","allocation_storage","allocation_over_room","allocation_over_load","delivery_mismatch","not_priced","queued_before_applied","payable_negative"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["apply","settleDelivery","unapply","queue","pullBack","settle"],"additionalProperties":false}},"required":["ticketId","ticketNo","crop","contractNo","split","netBu","moisture","moistureHigh","scaleNetBu","overBu","onContractBu","parties","money","verdicts"],"additionalProperties":false}},"money":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"preview"},"gross":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"deductions":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["checkoff","indemnity","inspection","drying","storage","freight"]},"label":{"type":"string","minLength":1,"maxLength":200},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","label","amount"],"additionalProperties":false}},"advanceRecovered":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"net":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","gross","deductions","advanceRecovered","net"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"posted"},"net":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","net"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unpriced"}},"required":["kind"],"additionalProperties":false}]}},"required":["tab","accountId","name","payMethod","terms","jointPayee","ticketCount","bushels","crop","reviewNote","tickets","money"],"additionalProperties":false}},"tabs":{"type":"object","properties":{"ready":{"type":"integer","minimum":0,"maximum":9007199254740991},"review":{"type":"integer","minimum":0,"maximum":9007199254740991},"sent":{"type":"integer","minimum":0,"maximum":9007199254740991},"cleared":{"type":"integer","minimum":0,"maximum":9007199254740991},"direct":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["ready","review","sent","cleared","direct"],"additionalProperties":false},"stats":{"type":"object","properties":{"readyGrowers":{"type":"integer","minimum":0,"maximum":9007199254740991},"readyTickets":{"type":"integer","minimum":0,"maximum":9007199254740991},"sentTickets":{"type":"integer","minimum":0,"maximum":9007199254740991},"sentGrowers":{"type":"integer","minimum":0,"maximum":9007199254740991},"jointPayees":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["readyGrowers","readyTickets","sentTickets","sentGrowers","jointPayees"],"additionalProperties":false},"totals":{"type":"object","properties":{"readyNet":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"sentNet":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["readyNet","sentNet"],"additionalProperties":false},"today":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"issueStatement":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]}},"required":["rows","applied","exportDefaults","exportDefaultsByAccount","growers","tabs","stats","totals","today","issueStatement"],"additionalProperties":false}
grain.setUpElevatorBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
namestringrequired
regionstringrequired
citystringrequired
state"AL" | "AK" | "AZ" | "AR" | "CA" | "CO" | "CT" | "DE" | "DC" | "FL" | "GA" | "HI" | "ID" | "IL" | "IN" | "IA" | "KS" | "KY" | "LA" | "ME" | "MD" | "MA" | "MI" | "MN" | "MS" | "MO" | "MT" | "NE" | "NV" | "NH" | "NJ" | "NM" | "NY" | "NC" | "ND" | "OH" | "OK" | "OR" | "PA" | "RI" | "SC" | "SD" | "TN" | "TX" | "UT" | "VT" | "VA" | "WA" | "WV" | "WI" | "WY"required
capacityBunumberrequired
railServed"yes" | "no"required
pitsintegerrequired
4 schema notes
  • $.name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.region refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.city refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.capacityBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"region":{"type":"string","minLength":1,"maxLength":200},"city":{"type":"string","minLength":1,"maxLength":200},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"capacityBu":{"type":"number","minimum":0,"maximum":100000000},"railServed":{"type":"string","enum":["yes","no"]},"pits":{"type":"integer","minimum":0,"maximum":24}},"required":["name","region","city","state","capacityBu","railServed","pits"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["elevatorId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.shipGrainBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
binIdstring (uuid)required
shipBunumberrequired
shipDayCalendarDaymay be omitted
destinationstringrequired
2 schema notes
  • $.shipBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.destination refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"binId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"shipBu":{"type":"number","minimum":0,"maximum":100000000},"shipDay":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"destination":{"type":"string","minLength":1,"maxLength":200}},"required":["binId","shipBu","destination"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"movementId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["movementId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"bin_removed"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"insufficient_on_hand"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_bushels"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"empty_bin"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.signAgreementBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
serviceIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"serviceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["serviceId"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"serviceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["serviceId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_sent"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grain.structuredProductsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
Full logical schema
{"type":"object","properties":{}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
boardsarray of objectrequired
accountsarray of objectrequired
elevatorsarray of objectrequired
todayCalendarDayrequired
bookAccumulatorobject | objectrequired
22 schema notes
  • $.rows[].account refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].region refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].elevator refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].accumulationPrice refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].knockOut refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].perPeriodBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].comment runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].createdBy refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].accumulatedBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].knockedOutAt.periodBoard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].thisWeek.periodBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].periods[].periodBoard refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].periods[].periodBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].periods[].accumulatedBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.boards[].months[].futuresMonth refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.boards[].months[].label refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.boards[].months[].last refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.accounts[].name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.accounts[].region refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.elevators[].name refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"accumulatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accumulatorNo":{"type":"string","pattern":"^[A-Z]{3}-\\d+(-\\d+)?$"},"accumulatorType":{"type":"string","enum":["Weekly double up with knockout","Weekly accumulator","Daily double up with knockout","Daily accumulator"]},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"account":{"type":"string","minLength":1,"maxLength":200},"region":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"bushels":{"type":"number","minimum":0,"maximum":100000000},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"elevator":{"type":"string","minLength":1,"maxLength":200},"accumulationPrice":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"knockOut":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"perPeriodBu":{"type":"number","minimum":0,"maximum":100000000},"windowBegin":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"windowEnd":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"futuresMonth":{"type":"string","minLength":1,"maxLength":200},"deliveryDate":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"signedOn":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"contractRef":{"type":"string","pattern":"^\\d+$"},"issuedOn":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"comment":{"type":"string","maxLength":5000},"createdBy":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"bookedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"status":{"type":"string","enum":["active","knocked out","complete"]},"accumulatedBu":{"type":"number","minimum":0,"maximum":100000000},"weeksPriced":{"type":"integer","minimum":0,"maximum":52},"knockedOutAt":{"anyOf":[{"type":"object","properties":{"week":{"type":"integer","minimum":0,"maximum":52},"periodBoard":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"}},"required":["week","periodBoard"],"additionalProperties":false},{"type":"null"}]},"thisWeek":{"anyOf":[{"type":"object","properties":{"periodBu":{"type":"number","minimum":0,"maximum":100000000},"doubled":{"type":"boolean"},"knockedOut":{"type":"boolean"}},"required":["periodBu","doubled","knockedOut"],"additionalProperties":false},{"type":"null"}]},"periods":{"type":"array","items":{"type":"object","properties":{"week":{"type":"integer","minimum":0,"maximum":52},"periodBoard":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"periodBu":{"type":"number","minimum":0,"maximum":100000000},"doubled":{"type":"boolean"},"pricedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"accumulatedBu":{"type":"number","minimum":0,"maximum":100000000},"weeksPriced":{"type":"integer","minimum":0,"maximum":52}},"required":["week","periodBoard","periodBu","doubled","pricedAt","accumulatedBu","weeksPriced"],"additionalProperties":false}}},"required":["accumulatorId","accumulatorNo","accumulatorType","accountId","account","region","crop","bushels","elevatorId","elevator","accumulationPrice","knockOut","perPeriodBu","windowBegin","windowEnd","futuresMonth","deliveryDate","signedOn","contractRef","issuedOn","comment","createdBy","bookedAt","status","accumulatedBu","weeksPriced","knockedOutAt","thisWeek","periods"],"additionalProperties":false}},"boards":{"type":"array","items":{"type":"object","properties":{"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"months":{"type":"array","items":{"type":"object","properties":{"futuresMonth":{"type":"string","minLength":1,"maxLength":200},"label":{"type":"string","minLength":1,"maxLength":200},"last":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]}},"required":["futuresMonth","label","last"],"additionalProperties":false}}},"required":["crop","months"],"additionalProperties":false}},"accounts":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":200},"region":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]}},"required":["accountId","name","region"],"additionalProperties":false}},"elevators":{"type":"array","items":{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":200},"createdAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"}},"required":["elevatorId","name","createdAt"],"additionalProperties":false}},"today":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"bookAccumulator":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]}},"required":["rows","boards","accounts","elevators","today","bookAccumulator"],"additionalProperties":false}
grain.unapplyTicketBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
ticketIdstring (uuid)required
reasonstringrequired
1 schema note
  • $.reason refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reason":{"type":"string","minLength":1,"maxLength":200}},"required":["ticketId","reason"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"ticketId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["ticketId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_applied"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}

grainRequest

Grain requests and proposals

Grower and dealer request views, proposal fields, and review outcomes.

grainRequest.acceptBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
requestIdstring (uuid)required
revisionIdstring (uuid)required
submissionKeystring (uuid)required
Full logical schema
{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submissionKey":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["requestId","revisionId","submissionKey"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"envelopeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["requestId","revisionId","contractId","envelopeId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unprintable"},"characters":{"type":"array","items":{"type":"string"},"minItems":1}},"required":["code","characters"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_email"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_found","submission_changed","request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grainRequest.counterBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
requestIdstring (uuid)required
revisionIdstring (uuid)required
submissionKeystring (uuid)required
inquiryobjectrequired
2 schema notes
  • $.inquiry.deliveryWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.inquiry.quantity|0.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submissionKey":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"inquiry":{"type":"object","properties":{"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"deliveryWindow":{"type":"object","properties":{"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["startOn","endOn"],"additionalProperties":false},"quantity":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"bushels":{"type":"number","minimum":0,"maximum":10000000}},"required":["kind","bushels"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unknown"}},"required":["kind"],"additionalProperties":false}]},"bidId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["crop","elevatorId","deliveryWindow","quantity"],"additionalProperties":false}},"required":["requestId","revisionId","submissionKey","inquiry"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["requestId","revisionId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unprintable"},"characters":{"type":"array","items":{"type":"string"},"minItems":1}},"required":["code","characters"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_email"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_found","submission_changed","request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grainRequest.dealerInboxBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
limitintegerrequired
cursorstring | nullmay be omitted
1 schema note
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":100},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["limit"],"additionalProperties":false}

Output contains unmodeled nodes

FieldLogical typePresence
rowsarray of Unmodeled: intersectionrequired
totalintegerrequired
nextCursorstring | nullrequired
facetsobjectrequired
totalsobjectrequired
15 schema notes
  • $.rows[] unsupported: This schema node is unmodeled. Displayed component or inner shapes are informational; no accepted value shape is inferred for the missing representation.
  • $.rows[]&1.currentRevision|0.inquiry.deliveryWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.currentRevision|0.inquiry.quantity|0.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.currentRevision|1.proposal refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.currentRevision|1.proposal.cropClass refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.currentRevision|1.proposal.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.currentRevision|1.proposal.premiumsPicked[].premium refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.currentRevision|1.proposal.premiumsPicked[].amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.currentRevision|1.proposal.premiumsPicked runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.currentRevision|1.proposal.dpBasis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.currentRevision|1.proposal.boardLast refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.currentRevision|1.proposal.basis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.statusLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.nextActorLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.pricePerBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"x-unsupported":"intersection","x-declared-components":[{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"requested"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"initiatorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","id","companyId","accountId","initiatorUserId","createdAt","revisionId"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"proposed"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"initiatorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","id","companyId","accountId","initiatorUserId","createdAt","revisionId"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"declined"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"initiatorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"actorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"answeredAt":{"type":"string","format":"date-time","x-zod-type":"date"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["_tag","id","companyId","accountId","initiatorUserId","createdAt","revisionId","actorUserId","answeredAt"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"withdrawn"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"initiatorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"actorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"answeredAt":{"type":"string","format":"date-time","x-zod-type":"date"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["_tag","id","companyId","accountId","initiatorUserId","createdAt","revisionId","actorUserId","answeredAt"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"accepted"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"initiatorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"actorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"answeredAt":{"type":"string","format":"date-time","x-zod-type":"date"},"reason":{"type":"string","minLength":1,"maxLength":255},"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"envelopeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","id","companyId","accountId","initiatorUserId","createdAt","revisionId","actorUserId","answeredAt","contractId","envelopeId"],"additionalProperties":false}]},{"type":"object","properties":{"accountName":{"type":"string","minLength":1,"maxLength":255},"elevators":{"type":"array","items":{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"city":{"type":"string","minLength":1,"maxLength":255},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]}},"required":["elevatorId","name","city","state"],"additionalProperties":false}},"currentRevision":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"requestRevision"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priorRevisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"authorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submittedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"channel":{"type":"string","enum":["growerPortal","dealerWorkspace"]},"kind":{"type":"string","const":"inquiry"},"inquiry":{"type":"object","properties":{"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"deliveryWindow":{"type":"object","properties":{"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["startOn","endOn"],"additionalProperties":false},"quantity":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"bushels":{"type":"number","minimum":0,"maximum":10000000}},"required":["kind","bushels"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unknown"}},"required":["kind"],"additionalProperties":false}]},"bidId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["crop","elevatorId","deliveryWindow","quantity"],"additionalProperties":false}},"required":["_tag","id","requestId","authorUserId","submittedAt","channel","kind","inquiry"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"requestRevision"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priorRevisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"authorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submittedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"channel":{"type":"string","enum":["growerPortal","dealerWorkspace"]},"kind":{"type":"string","const":"proposal"},"proposal":{"type":"object","properties":{"dealType":{"type":"string","const":"origination"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"cropClass":{"type":"string","minLength":1,"maxLength":200},"gradeCommitted":{"type":"string","minLength":1,"maxLength":255},"bushels":{"type":"number","minimum":0,"maximum":10000000},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priceMode":{"type":"string","const":"price now"},"contractType":{"type":"string","const":"full priced"},"premiumsPicked":{"type":"array","items":{"type":"object","properties":{"premium":{"type":"string","minLength":1,"maxLength":200},"amount":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"}},"required":["premium","amount"],"additionalProperties":false}},"futuresMonth":{"type":"string","minLength":1,"maxLength":255},"dpBasis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"deliveryMonth":{"type":"string","minLength":1,"maxLength":255},"targetStart":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"targetEnd":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"counterparties":{"type":"array","prefixItems":[],"minItems":0,"items":false,"maxItems":0},"boardLast":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"basis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"proposalExpiresAt":{"type":"string","format":"date-time","x-zod-type":"date"},"signingDeadlineAt":{"type":"string","format":"date-time","x-zod-type":"date"}},"required":["dealType","crop","gradeCommitted","bushels","elevatorId","priceMode","contractType","premiumsPicked","futuresMonth","deliveryMonth","targetStart","targetEnd","counterparties","boardLast","basis","proposalExpiresAt","signingDeadlineAt"],"additionalProperties":false}},"required":["_tag","id","requestId","authorUserId","submittedAt","channel","kind","proposal"],"additionalProperties":false}]},"status":{"type":"string","enum":["requested","proposed","expired","declined","withdrawn","accepted"]},"nextActor":{"type":"string","enum":["dealer","grower","none"]},"verdicts":{"type":"object","properties":{"issueProposal":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]},"decline":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]},"withdraw":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]},"replaceProposal":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]},"counter":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]},"accept":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["issueProposal","decline","withdraw","replaceProposal","counter","accept"],"additionalProperties":false},"statusLabel":{"type":"string","minLength":1,"maxLength":200},"nextActorLabel":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"pricePerBu":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]}},"required":["accountName","elevators","currentRevision","status","nextActor","verdicts","statusLabel","nextActorLabel","pricePerBu"],"additionalProperties":false}]}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"facets":{"type":"object","properties":{},"additionalProperties":false},"totals":{"type":"object","properties":{"verdicts":{"type":"object","properties":{"createProposal":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]}},"required":["createProposal"],"additionalProperties":false}},"required":["verdicts"],"additionalProperties":false}},"required":["rows","total","nextCursor","facets","totals"],"additionalProperties":false}
grainRequest.dealerReviewBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
requestIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["requestId"],"additionalProperties":false}

Output shape documented

FieldLogical typePresence
accountNamestringrequired
elevatorsarray of objectrequired
requestobject | object | object | object | objectrequired
revisionsarray of object | objectrequired
currentRevisionobject | objectrequired
verdictsobjectrequired
nowstring (date-time)required
pricePerBuUnitPrice | nullrequired
statusLabelstringrequired
nextActorLabelstring | nullrequired
status"requested" | "proposed" | "expired" | "declined" | "withdrawn" | "accepted"required
nextActor"dealer" | "grower" | "none"required
23 schema notes
  • $.revisions[]|0.inquiry.deliveryWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.revisions[]|0.inquiry.quantity|0.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.revisions[]|1.proposal refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.revisions[]|1.proposal.cropClass refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.revisions[]|1.proposal.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.revisions[]|1.proposal.premiumsPicked[].premium refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.revisions[]|1.proposal.premiumsPicked[].amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.revisions[]|1.proposal.premiumsPicked runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.revisions[]|1.proposal.dpBasis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.revisions[]|1.proposal.boardLast refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.revisions[]|1.proposal.basis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|0.inquiry.deliveryWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|0.inquiry.quantity|0.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|1.proposal refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|1.proposal.cropClass refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|1.proposal.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|1.proposal.premiumsPicked[].premium refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|1.proposal.premiumsPicked[].amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|1.proposal.premiumsPicked runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|1.proposal.dpBasis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|1.proposal.boardLast refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|1.proposal.basis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.pricePerBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"accountName":{"type":"string","minLength":1,"maxLength":255},"elevators":{"type":"array","items":{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"city":{"type":"string","minLength":1,"maxLength":255},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]}},"required":["elevatorId","name","city","state"],"additionalProperties":false}},"request":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"requested"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"initiatorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","id","companyId","accountId","initiatorUserId","createdAt","revisionId"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"proposed"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"initiatorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","id","companyId","accountId","initiatorUserId","createdAt","revisionId"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"declined"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"initiatorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"actorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"answeredAt":{"type":"string","format":"date-time","x-zod-type":"date"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["_tag","id","companyId","accountId","initiatorUserId","createdAt","revisionId","actorUserId","answeredAt"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"withdrawn"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"initiatorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"actorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"answeredAt":{"type":"string","format":"date-time","x-zod-type":"date"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["_tag","id","companyId","accountId","initiatorUserId","createdAt","revisionId","actorUserId","answeredAt"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"accepted"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"initiatorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"actorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"answeredAt":{"type":"string","format":"date-time","x-zod-type":"date"},"reason":{"type":"string","minLength":1,"maxLength":255},"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"envelopeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","id","companyId","accountId","initiatorUserId","createdAt","revisionId","actorUserId","answeredAt","contractId","envelopeId"],"additionalProperties":false}]},"revisions":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"requestRevision"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priorRevisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"authorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submittedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"channel":{"type":"string","enum":["growerPortal","dealerWorkspace"]},"kind":{"type":"string","const":"inquiry"},"inquiry":{"type":"object","properties":{"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"deliveryWindow":{"type":"object","properties":{"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["startOn","endOn"],"additionalProperties":false},"quantity":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"bushels":{"type":"number","minimum":0,"maximum":10000000}},"required":["kind","bushels"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unknown"}},"required":["kind"],"additionalProperties":false}]},"bidId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["crop","elevatorId","deliveryWindow","quantity"],"additionalProperties":false}},"required":["_tag","id","requestId","authorUserId","submittedAt","channel","kind","inquiry"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"requestRevision"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priorRevisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"authorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submittedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"channel":{"type":"string","enum":["growerPortal","dealerWorkspace"]},"kind":{"type":"string","const":"proposal"},"proposal":{"type":"object","properties":{"dealType":{"type":"string","const":"origination"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"cropClass":{"type":"string","minLength":1,"maxLength":200},"gradeCommitted":{"type":"string","minLength":1,"maxLength":255},"bushels":{"type":"number","minimum":0,"maximum":10000000},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priceMode":{"type":"string","const":"price now"},"contractType":{"type":"string","const":"full priced"},"premiumsPicked":{"type":"array","items":{"type":"object","properties":{"premium":{"type":"string","minLength":1,"maxLength":200},"amount":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"}},"required":["premium","amount"],"additionalProperties":false}},"futuresMonth":{"type":"string","minLength":1,"maxLength":255},"dpBasis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"deliveryMonth":{"type":"string","minLength":1,"maxLength":255},"targetStart":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"targetEnd":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"counterparties":{"type":"array","prefixItems":[],"minItems":0,"items":false,"maxItems":0},"boardLast":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"basis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"proposalExpiresAt":{"type":"string","format":"date-time","x-zod-type":"date"},"signingDeadlineAt":{"type":"string","format":"date-time","x-zod-type":"date"}},"required":["dealType","crop","gradeCommitted","bushels","elevatorId","priceMode","contractType","premiumsPicked","futuresMonth","deliveryMonth","targetStart","targetEnd","counterparties","boardLast","basis","proposalExpiresAt","signingDeadlineAt"],"additionalProperties":false}},"required":["_tag","id","requestId","authorUserId","submittedAt","channel","kind","proposal"],"additionalProperties":false}]}},"currentRevision":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"requestRevision"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priorRevisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"authorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submittedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"channel":{"type":"string","enum":["growerPortal","dealerWorkspace"]},"kind":{"type":"string","const":"inquiry"},"inquiry":{"type":"object","properties":{"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"deliveryWindow":{"type":"object","properties":{"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["startOn","endOn"],"additionalProperties":false},"quantity":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"bushels":{"type":"number","minimum":0,"maximum":10000000}},"required":["kind","bushels"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unknown"}},"required":["kind"],"additionalProperties":false}]},"bidId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["crop","elevatorId","deliveryWindow","quantity"],"additionalProperties":false}},"required":["_tag","id","requestId","authorUserId","submittedAt","channel","kind","inquiry"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"requestRevision"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priorRevisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"authorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submittedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"channel":{"type":"string","enum":["growerPortal","dealerWorkspace"]},"kind":{"type":"string","const":"proposal"},"proposal":{"type":"object","properties":{"dealType":{"type":"string","const":"origination"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"cropClass":{"type":"string","minLength":1,"maxLength":200},"gradeCommitted":{"type":"string","minLength":1,"maxLength":255},"bushels":{"type":"number","minimum":0,"maximum":10000000},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priceMode":{"type":"string","const":"price now"},"contractType":{"type":"string","const":"full priced"},"premiumsPicked":{"type":"array","items":{"type":"object","properties":{"premium":{"type":"string","minLength":1,"maxLength":200},"amount":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"}},"required":["premium","amount"],"additionalProperties":false}},"futuresMonth":{"type":"string","minLength":1,"maxLength":255},"dpBasis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"deliveryMonth":{"type":"string","minLength":1,"maxLength":255},"targetStart":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"targetEnd":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"counterparties":{"type":"array","prefixItems":[],"minItems":0,"items":false,"maxItems":0},"boardLast":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"basis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"proposalExpiresAt":{"type":"string","format":"date-time","x-zod-type":"date"},"signingDeadlineAt":{"type":"string","format":"date-time","x-zod-type":"date"}},"required":["dealType","crop","gradeCommitted","bushels","elevatorId","priceMode","contractType","premiumsPicked","futuresMonth","deliveryMonth","targetStart","targetEnd","counterparties","boardLast","basis","proposalExpiresAt","signingDeadlineAt"],"additionalProperties":false}},"required":["_tag","id","requestId","authorUserId","submittedAt","channel","kind","proposal"],"additionalProperties":false}]},"verdicts":{"type":"object","properties":{"issueProposal":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]},"decline":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]},"withdraw":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]},"replaceProposal":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]},"counter":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]},"accept":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["issueProposal","decline","withdraw","replaceProposal","counter","accept"],"additionalProperties":false},"now":{"type":"string","format":"date-time","x-zod-type":"date"},"pricePerBu":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"statusLabel":{"type":"string","minLength":1,"maxLength":255},"nextActorLabel":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"status":{"type":"string","enum":["requested","proposed","expired","declined","withdrawn","accepted"]},"nextActor":{"type":"string","enum":["dealer","grower","none"]}},"required":["accountName","elevators","request","revisions","currentRevision","verdicts","now","pricePerBu","statusLabel","nextActorLabel","status","nextActor"],"additionalProperties":false}
grainRequest.declineBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
requestIdstring (uuid)required
revisionIdstring (uuid)required
submissionKeystring (uuid)required
reasonstringmay be omitted
Full logical schema
{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submissionKey":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["requestId","revisionId","submissionKey"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["requestId","revisionId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unprintable"},"characters":{"type":"array","items":{"type":"string"},"minItems":1}},"required":["code","characters"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_email"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_found","submission_changed","request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grainRequest.growerAccountsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealerstring (uuid)required
Full logical schema
{"type":"object","properties":{"dealer":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealer"],"additionalProperties":false}

Output shape documented

FieldLogical typePresence
accountsarray of objectrequired
Full logical schema
{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255}},"required":["accountId","name"],"additionalProperties":false}}},"required":["accounts"],"additionalProperties":false}
grainRequest.growerInboxBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
limitintegerrequired
cursorstring | nullmay be omitted
dealerstring (uuid)required
1 schema note
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":100},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"dealer":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["limit","dealer"],"additionalProperties":false}

Output contains unmodeled nodes

FieldLogical typePresence
rowsarray of Unmodeled: intersectionrequired
totalintegerrequired
nextCursorstring | nullrequired
facetsobjectrequired
15 schema notes
  • $.rows[] unsupported: This schema node is unmodeled. Displayed component or inner shapes are informational; no accepted value shape is inferred for the missing representation.
  • $.rows[]&1.currentRevision|0.inquiry.deliveryWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.currentRevision|0.inquiry.quantity|0.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.currentRevision|1.proposal refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.currentRevision|1.proposal.cropClass refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.currentRevision|1.proposal.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.currentRevision|1.proposal.premiumsPicked[].premium refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.currentRevision|1.proposal.premiumsPicked[].amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.currentRevision|1.proposal.premiumsPicked runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.currentRevision|1.proposal.dpBasis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.currentRevision|1.proposal.boardLast refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.currentRevision|1.proposal.basis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.statusLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.nextActorLabel refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]&1.pricePerBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"x-unsupported":"intersection","x-declared-components":[{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"requested"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"initiatorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","id","companyId","accountId","initiatorUserId","createdAt","revisionId"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"proposed"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"initiatorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","id","companyId","accountId","initiatorUserId","createdAt","revisionId"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"declined"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"initiatorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"actorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"answeredAt":{"type":"string","format":"date-time","x-zod-type":"date"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["_tag","id","companyId","accountId","initiatorUserId","createdAt","revisionId","actorUserId","answeredAt"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"withdrawn"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"initiatorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"actorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"answeredAt":{"type":"string","format":"date-time","x-zod-type":"date"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["_tag","id","companyId","accountId","initiatorUserId","createdAt","revisionId","actorUserId","answeredAt"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"accepted"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"initiatorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"actorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"answeredAt":{"type":"string","format":"date-time","x-zod-type":"date"},"reason":{"type":"string","minLength":1,"maxLength":255},"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"envelopeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","id","companyId","accountId","initiatorUserId","createdAt","revisionId","actorUserId","answeredAt","contractId","envelopeId"],"additionalProperties":false}]},{"type":"object","properties":{"accountName":{"type":"string","minLength":1,"maxLength":255},"elevators":{"type":"array","items":{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"city":{"type":"string","minLength":1,"maxLength":255},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]}},"required":["elevatorId","name","city","state"],"additionalProperties":false}},"currentRevision":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"requestRevision"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priorRevisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"authorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submittedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"channel":{"type":"string","enum":["growerPortal","dealerWorkspace"]},"kind":{"type":"string","const":"inquiry"},"inquiry":{"type":"object","properties":{"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"deliveryWindow":{"type":"object","properties":{"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["startOn","endOn"],"additionalProperties":false},"quantity":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"bushels":{"type":"number","minimum":0,"maximum":10000000}},"required":["kind","bushels"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unknown"}},"required":["kind"],"additionalProperties":false}]},"bidId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["crop","elevatorId","deliveryWindow","quantity"],"additionalProperties":false}},"required":["_tag","id","requestId","authorUserId","submittedAt","channel","kind","inquiry"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"requestRevision"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priorRevisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"authorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submittedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"channel":{"type":"string","enum":["growerPortal","dealerWorkspace"]},"kind":{"type":"string","const":"proposal"},"proposal":{"type":"object","properties":{"dealType":{"type":"string","const":"origination"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"cropClass":{"type":"string","minLength":1,"maxLength":200},"gradeCommitted":{"type":"string","minLength":1,"maxLength":255},"bushels":{"type":"number","minimum":0,"maximum":10000000},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priceMode":{"type":"string","const":"price now"},"contractType":{"type":"string","const":"full priced"},"premiumsPicked":{"type":"array","items":{"type":"object","properties":{"premium":{"type":"string","minLength":1,"maxLength":200},"amount":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"}},"required":["premium","amount"],"additionalProperties":false}},"futuresMonth":{"type":"string","minLength":1,"maxLength":255},"dpBasis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"deliveryMonth":{"type":"string","minLength":1,"maxLength":255},"targetStart":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"targetEnd":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"counterparties":{"type":"array","prefixItems":[],"minItems":0,"items":false,"maxItems":0},"boardLast":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"basis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"proposalExpiresAt":{"type":"string","format":"date-time","x-zod-type":"date"},"signingDeadlineAt":{"type":"string","format":"date-time","x-zod-type":"date"}},"required":["dealType","crop","gradeCommitted","bushels","elevatorId","priceMode","contractType","premiumsPicked","futuresMonth","deliveryMonth","targetStart","targetEnd","counterparties","boardLast","basis","proposalExpiresAt","signingDeadlineAt"],"additionalProperties":false}},"required":["_tag","id","requestId","authorUserId","submittedAt","channel","kind","proposal"],"additionalProperties":false}]},"status":{"type":"string","enum":["requested","proposed","expired","declined","withdrawn","accepted"]},"nextActor":{"type":"string","enum":["dealer","grower","none"]},"verdicts":{"type":"object","properties":{"issueProposal":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]},"decline":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]},"withdraw":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]},"replaceProposal":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]},"counter":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]},"accept":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["issueProposal","decline","withdraw","replaceProposal","counter","accept"],"additionalProperties":false},"statusLabel":{"type":"string","minLength":1,"maxLength":200},"nextActorLabel":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"pricePerBu":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]}},"required":["accountName","elevators","currentRevision","status","nextActor","verdicts","statusLabel","nextActorLabel","pricePerBu"],"additionalProperties":false}]}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"facets":{"type":"object","properties":{},"additionalProperties":false}},"required":["rows","total","nextCursor","facets"],"additionalProperties":false}
grainRequest.growerReviewBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
requestIdstring (uuid)required
dealerstring (uuid)required
Full logical schema
{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dealer":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["requestId","dealer"],"additionalProperties":false}

Output shape documented

FieldLogical typePresence
accountNamestringrequired
elevatorsarray of objectrequired
requestobject | object | object | object | objectrequired
revisionsarray of object | objectrequired
currentRevisionobject | objectrequired
verdictsobjectrequired
nowstring (date-time)required
pricePerBuUnitPrice | nullrequired
statusLabelstringrequired
nextActorLabelstring | nullrequired
status"requested" | "proposed" | "expired" | "declined" | "withdrawn" | "accepted"required
nextActor"dealer" | "grower" | "none"required
23 schema notes
  • $.revisions[]|0.inquiry.deliveryWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.revisions[]|0.inquiry.quantity|0.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.revisions[]|1.proposal refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.revisions[]|1.proposal.cropClass refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.revisions[]|1.proposal.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.revisions[]|1.proposal.premiumsPicked[].premium refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.revisions[]|1.proposal.premiumsPicked[].amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.revisions[]|1.proposal.premiumsPicked runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.revisions[]|1.proposal.dpBasis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.revisions[]|1.proposal.boardLast refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.revisions[]|1.proposal.basis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|0.inquiry.deliveryWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|0.inquiry.quantity|0.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|1.proposal refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|1.proposal.cropClass refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|1.proposal.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|1.proposal.premiumsPicked[].premium refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|1.proposal.premiumsPicked[].amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|1.proposal.premiumsPicked runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|1.proposal.dpBasis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|1.proposal.boardLast refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.currentRevision|1.proposal.basis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.pricePerBu refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"accountName":{"type":"string","minLength":1,"maxLength":255},"elevators":{"type":"array","items":{"type":"object","properties":{"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"city":{"type":"string","minLength":1,"maxLength":255},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]}},"required":["elevatorId","name","city","state"],"additionalProperties":false}},"request":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"requested"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"initiatorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","id","companyId","accountId","initiatorUserId","createdAt","revisionId"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"proposed"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"initiatorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","id","companyId","accountId","initiatorUserId","createdAt","revisionId"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"declined"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"initiatorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"actorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"answeredAt":{"type":"string","format":"date-time","x-zod-type":"date"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["_tag","id","companyId","accountId","initiatorUserId","createdAt","revisionId","actorUserId","answeredAt"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"withdrawn"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"initiatorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"actorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"answeredAt":{"type":"string","format":"date-time","x-zod-type":"date"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["_tag","id","companyId","accountId","initiatorUserId","createdAt","revisionId","actorUserId","answeredAt"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"accepted"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"initiatorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"actorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"answeredAt":{"type":"string","format":"date-time","x-zod-type":"date"},"reason":{"type":"string","minLength":1,"maxLength":255},"contractId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"envelopeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","id","companyId","accountId","initiatorUserId","createdAt","revisionId","actorUserId","answeredAt","contractId","envelopeId"],"additionalProperties":false}]},"revisions":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"requestRevision"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priorRevisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"authorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submittedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"channel":{"type":"string","enum":["growerPortal","dealerWorkspace"]},"kind":{"type":"string","const":"inquiry"},"inquiry":{"type":"object","properties":{"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"deliveryWindow":{"type":"object","properties":{"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["startOn","endOn"],"additionalProperties":false},"quantity":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"bushels":{"type":"number","minimum":0,"maximum":10000000}},"required":["kind","bushels"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unknown"}},"required":["kind"],"additionalProperties":false}]},"bidId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["crop","elevatorId","deliveryWindow","quantity"],"additionalProperties":false}},"required":["_tag","id","requestId","authorUserId","submittedAt","channel","kind","inquiry"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"requestRevision"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priorRevisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"authorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submittedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"channel":{"type":"string","enum":["growerPortal","dealerWorkspace"]},"kind":{"type":"string","const":"proposal"},"proposal":{"type":"object","properties":{"dealType":{"type":"string","const":"origination"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"cropClass":{"type":"string","minLength":1,"maxLength":200},"gradeCommitted":{"type":"string","minLength":1,"maxLength":255},"bushels":{"type":"number","minimum":0,"maximum":10000000},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priceMode":{"type":"string","const":"price now"},"contractType":{"type":"string","const":"full priced"},"premiumsPicked":{"type":"array","items":{"type":"object","properties":{"premium":{"type":"string","minLength":1,"maxLength":200},"amount":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"}},"required":["premium","amount"],"additionalProperties":false}},"futuresMonth":{"type":"string","minLength":1,"maxLength":255},"dpBasis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"deliveryMonth":{"type":"string","minLength":1,"maxLength":255},"targetStart":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"targetEnd":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"counterparties":{"type":"array","prefixItems":[],"minItems":0,"items":false,"maxItems":0},"boardLast":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"basis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"proposalExpiresAt":{"type":"string","format":"date-time","x-zod-type":"date"},"signingDeadlineAt":{"type":"string","format":"date-time","x-zod-type":"date"}},"required":["dealType","crop","gradeCommitted","bushels","elevatorId","priceMode","contractType","premiumsPicked","futuresMonth","deliveryMonth","targetStart","targetEnd","counterparties","boardLast","basis","proposalExpiresAt","signingDeadlineAt"],"additionalProperties":false}},"required":["_tag","id","requestId","authorUserId","submittedAt","channel","kind","proposal"],"additionalProperties":false}]}},"currentRevision":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"requestRevision"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priorRevisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"authorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submittedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"channel":{"type":"string","enum":["growerPortal","dealerWorkspace"]},"kind":{"type":"string","const":"inquiry"},"inquiry":{"type":"object","properties":{"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"deliveryWindow":{"type":"object","properties":{"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["startOn","endOn"],"additionalProperties":false},"quantity":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"bushels":{"type":"number","minimum":0,"maximum":10000000}},"required":["kind","bushels"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unknown"}},"required":["kind"],"additionalProperties":false}]},"bidId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["crop","elevatorId","deliveryWindow","quantity"],"additionalProperties":false}},"required":["_tag","id","requestId","authorUserId","submittedAt","channel","kind","inquiry"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"requestRevision"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priorRevisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"authorUserId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submittedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"channel":{"type":"string","enum":["growerPortal","dealerWorkspace"]},"kind":{"type":"string","const":"proposal"},"proposal":{"type":"object","properties":{"dealType":{"type":"string","const":"origination"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"cropClass":{"type":"string","minLength":1,"maxLength":200},"gradeCommitted":{"type":"string","minLength":1,"maxLength":255},"bushels":{"type":"number","minimum":0,"maximum":10000000},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priceMode":{"type":"string","const":"price now"},"contractType":{"type":"string","const":"full priced"},"premiumsPicked":{"type":"array","items":{"type":"object","properties":{"premium":{"type":"string","minLength":1,"maxLength":200},"amount":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"}},"required":["premium","amount"],"additionalProperties":false}},"futuresMonth":{"type":"string","minLength":1,"maxLength":255},"dpBasis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"deliveryMonth":{"type":"string","minLength":1,"maxLength":255},"targetStart":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"targetEnd":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"counterparties":{"type":"array","prefixItems":[],"minItems":0,"items":false,"maxItems":0},"boardLast":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"basis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"proposalExpiresAt":{"type":"string","format":"date-time","x-zod-type":"date"},"signingDeadlineAt":{"type":"string","format":"date-time","x-zod-type":"date"}},"required":["dealType","crop","gradeCommitted","bushels","elevatorId","priceMode","contractType","premiumsPicked","futuresMonth","deliveryMonth","targetStart","targetEnd","counterparties","boardLast","basis","proposalExpiresAt","signingDeadlineAt"],"additionalProperties":false}},"required":["_tag","id","requestId","authorUserId","submittedAt","channel","kind","proposal"],"additionalProperties":false}]},"verdicts":{"type":"object","properties":{"issueProposal":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]},"decline":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]},"withdraw":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]},"replaceProposal":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]},"counter":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]},"accept":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["issueProposal","decline","withdraw","replaceProposal","counter","accept"],"additionalProperties":false},"now":{"type":"string","format":"date-time","x-zod-type":"date"},"pricePerBu":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},{"type":"null"}]},"statusLabel":{"type":"string","minLength":1,"maxLength":255},"nextActorLabel":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"status":{"type":"string","enum":["requested","proposed","expired","declined","withdrawn","accepted"]},"nextActor":{"type":"string","enum":["dealer","grower","none"]}},"required":["accountName","elevators","request","revisions","currentRevision","verdicts","now","pricePerBu","statusLabel","nextActorLabel","status","nextActor"],"additionalProperties":false}
grainRequest.inquireBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealerstring (uuid)required
accountIdstring (uuid)required
submissionKeystring (uuid)required
inquiryobjectrequired
2 schema notes
  • $.inquiry.deliveryWindow refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.inquiry.quantity|0.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"dealer":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submissionKey":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"inquiry":{"type":"object","properties":{"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"deliveryWindow":{"type":"object","properties":{"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["startOn","endOn"],"additionalProperties":false},"quantity":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"known"},"bushels":{"type":"number","minimum":0,"maximum":10000000}},"required":["kind","bushels"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unknown"}},"required":["kind"],"additionalProperties":false}]},"bidId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["crop","elevatorId","deliveryWindow","quantity"],"additionalProperties":false}},"required":["dealer","accountId","submissionKey","inquiry"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["requestId","revisionId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unprintable"},"characters":{"type":"array","items":{"type":"string"},"minItems":1}},"required":["code","characters"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_email"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_found","submission_changed","request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grainRequest.issueProposalBusiness procedure UI supported

Input shape documented

object | object

22 schema notes
  • $|0.proposal refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.proposal.cropClass refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.proposal.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.proposal.premiumsPicked[].premium refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.proposal.premiumsPicked[].amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.proposal.premiumsPicked runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.proposal.dpBasis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.proposal.boardLast refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.proposal.basis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.proposal.proposalExpiresAt refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.proposal.signingDeadlineAt refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.proposal refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.proposal.cropClass refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.proposal.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.proposal.premiumsPicked[].premium refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.proposal.premiumsPicked[].amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.proposal.premiumsPicked runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.proposal.dpBasis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.proposal.boardLast refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.proposal.basis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.proposal.proposalExpiresAt runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.proposal.signingDeadlineAt runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"anyOf":[{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submissionKey":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"proposal":{"type":"object","properties":{"dealType":{"type":"string","const":"origination"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"cropClass":{"type":"string","minLength":1,"maxLength":200},"gradeCommitted":{"type":"string","minLength":1,"maxLength":255},"bushels":{"type":"number","minimum":0,"maximum":10000000},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priceMode":{"type":"string","const":"price now"},"contractType":{"type":"string","const":"full priced"},"premiumsPicked":{"type":"array","items":{"type":"object","properties":{"premium":{"type":"string","minLength":1,"maxLength":200},"amount":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"}},"required":["premium","amount"]}},"futuresMonth":{"type":"string","minLength":1,"maxLength":255},"dpBasis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"deliveryMonth":{"type":"string","minLength":1,"maxLength":255},"targetStart":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"targetEnd":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"counterparties":{"type":"array","prefixItems":[],"minItems":0,"items":false,"maxItems":0},"boardLast":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"basis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"proposalExpiresAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"signingDeadlineAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"}},"required":["dealType","crop","gradeCommitted","bushels","elevatorId","priceMode","contractType","futuresMonth","deliveryMonth","targetStart","targetEnd","counterparties","boardLast","basis","proposalExpiresAt","signingDeadlineAt"],"additionalProperties":false}},"required":["requestId","revisionId","submissionKey","proposal"],"additionalProperties":false},{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submissionKey":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"proposal":{"type":"object","properties":{"dealType":{"type":"string","const":"origination"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"cropClass":{"type":"string","minLength":1,"maxLength":200},"gradeCommitted":{"type":"string","minLength":1,"maxLength":255},"bushels":{"type":"number","minimum":0,"maximum":10000000},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priceMode":{"type":"string","const":"price now"},"contractType":{"type":"string","const":"full priced"},"premiumsPicked":{"type":"array","items":{"type":"object","properties":{"premium":{"type":"string","minLength":1,"maxLength":200},"amount":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"}},"required":["premium","amount"]}},"futuresMonth":{"type":"string","minLength":1,"maxLength":255},"dpBasis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"deliveryMonth":{"type":"string","minLength":1,"maxLength":255},"targetStart":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"targetEnd":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"counterparties":{"type":"array","prefixItems":[],"minItems":0,"items":false,"maxItems":0},"boardLast":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"basis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"proposalExpiresAt":{"type":"string","format":"date-time","x-zod-type":"date"},"signingDeadlineAt":{"type":"string","format":"date-time","x-zod-type":"date"}},"required":["dealType","crop","gradeCommitted","bushels","elevatorId","priceMode","contractType","futuresMonth","deliveryMonth","targetStart","targetEnd","counterparties","boardLast","basis","proposalExpiresAt","signingDeadlineAt"],"additionalProperties":false}},"required":["requestId","revisionId","submissionKey","proposal"],"additionalProperties":false}]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["requestId","revisionId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unprintable"},"characters":{"type":"array","items":{"type":"string"},"minItems":1}},"required":["code","characters"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_email"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_found","submission_changed","request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
grainRequest.proposalEditorBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
targetobject | objectrequired
Full logical schema
{"type":"object","properties":{"target":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"new"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","accountId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"existing"},"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","requestId"],"additionalProperties":false}]}},"required":["target"],"additionalProperties":false}

Output shape documented

FieldLogical typePresence
accountIdstring (uuid)required
timeZonestringrequired
seedobject | objectrequired
12 schema notes
  • $.timeZone refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.seed|1.proposal refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.seed|1.proposal.cropClass refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.seed|1.proposal.bushels refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.seed|1.proposal.premiumsPicked[].premium refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.seed|1.proposal.premiumsPicked[].amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.seed|1.proposal.premiumsPicked runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.seed|1.proposal.dpBasis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.seed|1.proposal.boardLast refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.seed|1.proposal.basis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.seed|1.proposal.proposalExpiresAt refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.seed|1.proposal.signingDeadlineAt refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"timeZone":{"type":"string"},"seed":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"new"},"proposal":{"type":"null"}},"required":["kind","proposal"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"existing"},"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"proposal":{"anyOf":[{"type":"object","properties":{"dealType":{"type":"string","const":"origination"},"crop":{"type":"string","enum":["Corn","Soybeans","Wheat","Sorghum","Barley","Oats","Rye","Canola","Sunflower"]},"cropClass":{"type":"string","minLength":1,"maxLength":200},"gradeCommitted":{"type":"string","minLength":1,"maxLength":255},"bushels":{"type":"number","minimum":0,"maximum":10000000},"elevatorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"priceMode":{"type":"string","const":"price now"},"contractType":{"type":"string","const":"full priced"},"premiumsPicked":{"type":"array","items":{"type":"object","properties":{"premium":{"type":"string","minLength":1,"maxLength":200},"amount":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"}},"required":["premium","amount"],"additionalProperties":false}},"futuresMonth":{"type":"string","minLength":1,"maxLength":255},"dpBasis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"deliveryMonth":{"type":"string","minLength":1,"maxLength":255},"targetStart":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"targetEnd":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"counterparties":{"type":"array","prefixItems":[],"minItems":0,"items":false,"maxItems":0},"boardLast":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"basis":{"type":"string","format":"decimal","x-wire-kind":"UnitPrice"},"proposalExpiresAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"signingDeadlineAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"}},"required":["dealType","crop","gradeCommitted","bushels","elevatorId","priceMode","contractType","premiumsPicked","futuresMonth","deliveryMonth","targetStart","targetEnd","counterparties","boardLast","basis","proposalExpiresAt","signingDeadlineAt"],"additionalProperties":false},{"type":"null"}]}},"required":["kind","requestId","revisionId","proposal"],"additionalProperties":false}]}},"required":["accountId","timeZone","seed"],"additionalProperties":false}
grainRequest.withdrawBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
requestIdstring (uuid)required
revisionIdstring (uuid)required
submissionKeystring (uuid)required
reasonstringmay be omitted
Full logical schema
{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"submissionKey":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reason":{"type":"string","minLength":1,"maxLength":255}},"required":["requestId","revisionId","submissionKey"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"revisionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["requestId","revisionId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unprintable"},"characters":{"type":"array","items":{"type":"string"},"minItems":1}},"required":["code","characters"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_email"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_found","submission_changed","request_closed","revision_changed","not_recipient","not_connected","not_proposer","proposal_expired"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}

invoice

Invoices and collections

Invoice summaries, collection offers and outcomes, payment recording, and invoice sending fields.

invoice.byIdBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
idstring (uuid)required
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"]}

Output shape documented

FieldLogical typePresence
asOfInstantrequired
linesarray of object | object | object | objectrequired
invoicesarray of objectrequired
accountIdstring (uuid)required
dealIdstring (uuid)required
dealTitlestringrequired
orderIdstring (uuid)required
orderNumberinteger (counter)required
importProvenanceobject | nullrequired
closeOutobjectrequired
4 schema notes
  • $.lines[]|0.returnState runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[]|1.returnState runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[]|2.returnState runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[]|3.returnState runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"asOf":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"lines":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"fulfillmentLineId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"orderLineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"product":{"type":"string","minLength":1,"maxLength":255},"sku":{"type":"string","minLength":1,"maxLength":255},"orderedQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"fulfilledQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"openQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"unitPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"returnState":{"type":"string","enum":["none","inFlight","returned"]},"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"orderNumber":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"dealTitle":{"type":"string","minLength":1,"maxLength":255},"billing":{"type":"null"},"invoiceKey":{"type":"null"}},"required":["fulfillmentLineId","orderLineId","product","sku","orderedQty","fulfilledQty","openQty","unitPrice","amount","returnState","orderId","orderNumber","dealTitle","billing","invoiceKey"],"additionalProperties":false},{"type":"object","properties":{"fulfillmentLineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"orderLineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"product":{"type":"string","minLength":1,"maxLength":255},"sku":{"type":"string","minLength":1,"maxLength":255},"orderedQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"fulfilledQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"openQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"unitPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"returnState":{"type":"string","enum":["none","inFlight","returned"]},"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"orderNumber":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"dealTitle":{"type":"string","minLength":1,"maxLength":255},"billing":{"type":"string","const":"ready"},"invoiceKey":{"type":"null"}},"required":["fulfillmentLineId","orderLineId","product","sku","orderedQty","fulfilledQty","openQty","unitPrice","amount","returnState","orderId","orderNumber","dealTitle","billing","invoiceKey"],"additionalProperties":false},{"type":"object","properties":{"fulfillmentLineId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"orderLineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"product":{"type":"string","minLength":1,"maxLength":255},"sku":{"type":"string","minLength":1,"maxLength":255},"orderedQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"fulfilledQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"openQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"unitPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"returnState":{"type":"string","enum":["none","inFlight","returned"]},"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"orderNumber":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"dealTitle":{"type":"string","minLength":1,"maxLength":255},"billing":{"type":"string","const":"invoiced"},"invoiceKey":{"type":"string","minLength":1,"maxLength":255},"invoice":{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"issuedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"dueAt":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"terms":{"type":"string","minLength":1,"maxLength":255},"balance":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["chargeId","issuedAt","dueAt","terms","balance"],"additionalProperties":false}},"required":["fulfillmentLineId","orderLineId","product","sku","orderedQty","fulfilledQty","openQty","unitPrice","amount","returnState","orderId","orderNumber","dealTitle","billing","invoiceKey","invoice"],"additionalProperties":false},{"type":"object","properties":{"fulfillmentLineId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"orderLineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"product":{"type":"string","minLength":1,"maxLength":255},"sku":{"type":"string","minLength":1,"maxLength":255},"orderedQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"fulfilledQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"openQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"unitPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"returnState":{"type":"string","enum":["none","inFlight","returned"]},"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"orderNumber":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"dealTitle":{"type":"string","minLength":1,"maxLength":255},"billing":{"type":"string","const":"paid"},"invoiceKey":{"type":"string","minLength":1,"maxLength":255},"invoice":{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"issuedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"dueAt":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"terms":{"type":"string","minLength":1,"maxLength":255},"balance":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["chargeId","issuedAt","dueAt","terms","balance"],"additionalProperties":false}},"required":["fulfillmentLineId","orderLineId","product","sku","orderedQty","fulfilledQty","openQty","unitPrice","amount","returnState","orderId","orderNumber","dealTitle","billing","invoiceKey","invoice"],"additionalProperties":false}]}},"invoices":{"type":"array","items":{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"invoiceKey":{"type":"string","minLength":1,"maxLength":255},"invoiceAmount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"creditedAmount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"returnedAmount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"balance":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"payable":{"oneOf":[{"type":"object","properties":{"by":{"type":"string","const":"lines"},"lineIds":{"type":"array","prefixItems":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}],"minItems":1,"items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["by","lineIds","amount"],"additionalProperties":false},{"type":"object","properties":{"by":{"type":"string","const":"none"}},"required":["by"],"additionalProperties":false}]},"standing":{"type":"string","enum":["open","paymentPending","paymentIndeterminate","paymentFailed","partiallyPaid","paid"]},"payments":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"paymentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"method":{"type":"string","enum":["check","cash","ach"]},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"receivedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"}},"required":["paymentId","method","amount","receivedAt"],"additionalProperties":false},{"type":"object","properties":{"paymentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"method":{"type":"string","enum":["cfi_remit"]},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"receivedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"transactionId":{"type":"string","minLength":1,"maxLength":128}},"required":["paymentId","method","amount","receivedAt","transactionId"],"additionalProperties":false}]}},"drawAttempt":{"anyOf":[{"oneOf":[{"type":"object","properties":{"state":{"type":"string","const":"pending"},"paymentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"requestedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"}},"required":["state","paymentId","amount","requestedAt"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"failed"},"paymentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"failedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"detail":{"type":"string","minLength":1,"maxLength":255}},"required":["state","paymentId","amount","failedAt","detail"],"additionalProperties":false}]},{"type":"null"}]}},"required":["chargeId","invoiceKey","invoiceAmount","creditedAmount","returnedAmount","balance","payable","standing","payments","drawAttempt"],"additionalProperties":false}},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dealTitle":{"type":"string","minLength":1,"maxLength":255},"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"orderNumber":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"importProvenance":{"anyOf":[{"type":"object","properties":{"invoiceKey":{"type":"string","minLength":1,"maxLength":64}},"required":["invoiceKey"],"additionalProperties":false},{"type":"null"}]},"closeOut":{"type":"object","properties":{"fulfillment":{"type":"object","properties":{"itemsFulfilled":{"type":"integer","minimum":0,"maximum":9007199254740991},"itemsTotal":{"type":"integer","minimum":0,"maximum":9007199254740991},"state":{"type":"string","enum":["open","complete"]}},"required":["itemsFulfilled","itemsTotal","state"],"additionalProperties":false},"verdicts":{"type":"object","properties":{"stageQuote":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["unpriceable_line","not_fulfilled","not_invoiced","not_paid","not_discardable"]}},"required":["status","error"],"additionalProperties":false}]},"lose":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["unpriceable_line","not_fulfilled","not_invoiced","not_paid","not_discardable"]}},"required":["status","error"],"additionalProperties":false}]},"advanceToAccept":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["unpriceable_line","not_fulfilled","not_invoiced","not_paid","not_discardable"]}},"required":["status","error"],"additionalProperties":false}]},"reviseQuote":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["unpriceable_line","not_fulfilled","not_invoiced","not_paid","not_discardable"]}},"required":["status","error"],"additionalProperties":false}]},"win":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["unpriceable_line","not_fulfilled","not_invoiced","not_paid","not_discardable"]}},"required":["status","error"],"additionalProperties":false}]},"discard":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["unpriceable_line","not_fulfilled","not_invoiced","not_paid","not_discardable"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["stageQuote","lose","advanceToAccept","reviseQuote","win","discard"],"additionalProperties":false}},"required":["fulfillment","verdicts"],"additionalProperties":false}},"required":["asOf","lines","invoices","accountId","dealId","dealTitle","orderId","orderNumber","importProvenance","closeOut"],"additionalProperties":false}
invoice.cancelItemBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
loanRefstringrequired
chargeIdstring (uuid)required
lineIdstring (uuid)required
descriptionstringrequired
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"loanRef":{"type":"string","minLength":1,"maxLength":128},"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"description":{"type":"string","minLength":1,"maxLength":255}},"required":["accountId","loanRef","chargeId","lineId","description"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"returnId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"state":{"type":"string","enum":["posted","awaitingPosting","pending"]}},"required":["returnId","state"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_returnable"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"exceeds_returnable"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"line_delivered"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"return_refused"},"reason":{"type":"string","minLength":1}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"line_billed"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_found"},"entity":{"type":"string"},"ref":{"type":"string"}},"required":["code","entity","ref"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"declined"},"reason":{"type":"string"}},"required":["code","reason"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"insufficient_credit"},"requested":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"available":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"retriable":{"type":"boolean"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"ineligible"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"retriable":{"type":"boolean"}},"required":["code","reason"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"draw_in_progress"},"conflict":{"type":"string","const":"key_reused"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"incomplete"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"entities":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["person","organization","loan"]},"ref":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["kind","ref","errors"],"additionalProperties":false}},"detail":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unauthorized"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unavailable"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"wire_mismatch"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
invoice.cfiPayableBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["accountId"]}

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"invoiceKey":{"type":"string","minLength":1,"maxLength":255},"dueAt":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"balance":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["chargeId","orderId","invoiceKey","dueAt","balance"],"additionalProperties":false}}
invoice.collectionBoardBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
orderIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["accountId","orderId"]}

Output shape documented

FieldLogical typePresence
orderIdstring (uuid)required
orderNumberinteger (counter)required
titlestringrequired
linesarray of object | object | object | objectrequired
offersarray of objectrequired
collectionsarray of objectrequired
11 schema notes
  • $.lines[]|0.returnState runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[]|1.returnState runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[]|2.returnState runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[]|3.returnState runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].reason runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].tranches[].products runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].preselect runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.collections[].payments[].plan|0.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.collections[].payments[].plan|1.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.collections[].payments[].plan|2.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.collections[].payments[].plan|3.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"orderNumber":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"title":{"type":"string","minLength":1,"maxLength":255},"lines":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"fulfillmentLineId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"orderLineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"product":{"type":"string","minLength":1,"maxLength":255},"sku":{"type":"string","minLength":1,"maxLength":255},"orderedQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"fulfilledQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"openQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"unitPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"returnState":{"type":"string","enum":["none","inFlight","returned"]},"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"orderNumber":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"dealTitle":{"type":"string","minLength":1,"maxLength":255},"billing":{"type":"null"},"invoiceKey":{"type":"null"}},"required":["fulfillmentLineId","orderLineId","product","sku","orderedQty","fulfilledQty","openQty","unitPrice","amount","returnState","orderId","orderNumber","dealTitle","billing","invoiceKey"],"additionalProperties":false},{"type":"object","properties":{"fulfillmentLineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"orderLineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"product":{"type":"string","minLength":1,"maxLength":255},"sku":{"type":"string","minLength":1,"maxLength":255},"orderedQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"fulfilledQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"openQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"unitPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"returnState":{"type":"string","enum":["none","inFlight","returned"]},"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"orderNumber":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"dealTitle":{"type":"string","minLength":1,"maxLength":255},"billing":{"type":"string","const":"ready"},"invoiceKey":{"type":"null"}},"required":["fulfillmentLineId","orderLineId","product","sku","orderedQty","fulfilledQty","openQty","unitPrice","amount","returnState","orderId","orderNumber","dealTitle","billing","invoiceKey"],"additionalProperties":false},{"type":"object","properties":{"fulfillmentLineId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"orderLineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"product":{"type":"string","minLength":1,"maxLength":255},"sku":{"type":"string","minLength":1,"maxLength":255},"orderedQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"fulfilledQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"openQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"unitPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"returnState":{"type":"string","enum":["none","inFlight","returned"]},"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"orderNumber":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"dealTitle":{"type":"string","minLength":1,"maxLength":255},"billing":{"type":"string","const":"invoiced"},"invoiceKey":{"type":"string","minLength":1,"maxLength":255},"invoice":{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"issuedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"dueAt":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"terms":{"type":"string","minLength":1,"maxLength":255},"balance":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["chargeId","issuedAt","dueAt","terms","balance"],"additionalProperties":false}},"required":["fulfillmentLineId","orderLineId","product","sku","orderedQty","fulfilledQty","openQty","unitPrice","amount","returnState","orderId","orderNumber","dealTitle","billing","invoiceKey","invoice"],"additionalProperties":false},{"type":"object","properties":{"fulfillmentLineId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"orderLineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"product":{"type":"string","minLength":1,"maxLength":255},"sku":{"type":"string","minLength":1,"maxLength":255},"orderedQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"fulfilledQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"openQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"unitPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"returnState":{"type":"string","enum":["none","inFlight","returned"]},"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"orderNumber":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"dealTitle":{"type":"string","minLength":1,"maxLength":255},"billing":{"type":"string","const":"paid"},"invoiceKey":{"type":"string","minLength":1,"maxLength":255},"invoice":{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"issuedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"dueAt":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"terms":{"type":"string","minLength":1,"maxLength":255},"balance":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["chargeId","issuedAt","dueAt","terms","balance"],"additionalProperties":false}},"required":["fulfillmentLineId","orderLineId","product","sku","orderedQty","fulfilledQty","openQty","unitPrice","amount","returnState","orderId","orderNumber","dealTitle","billing","invoiceKey","invoice"],"additionalProperties":false}]}},"offers":{"type":"array","items":{"type":"object","properties":{"loanRef":{"type":"string","minLength":1,"maxLength":128},"title":{"type":"string","minLength":1,"maxLength":255},"answer":{"type":"string","enum":["checking","drawable","blocked"]},"available":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}]},"tranches":{"type":"array","items":{"type":"object","properties":{"trancheId":{"type":"string","minLength":1,"maxLength":128},"reference":{"type":"string"},"description":{"type":"string"},"products":{"type":"array","items":{"type":"object","properties":{"productUuid":{"type":"string"},"name":{"type":"string"}},"required":["productUuid","name"],"additionalProperties":false}}},"required":["trancheId","reference","description","products"],"additionalProperties":false}},"preselect":{"anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]}},"required":["loanRef","title","answer","available","reason","tranches","preselect"],"additionalProperties":false}},"collections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"state":{"anyOf":[{"type":"string","const":"collecting"},{"type":"string","const":"completed"}]},"lineIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"plan":{"oneOf":[{"type":"object","properties":{"method":{"type":"string","const":"ach"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["method","amount"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","const":"check"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["method","amount"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","const":"cash"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["method","amount"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","const":"cfi_remit"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"loanRef":{"type":"string","minLength":1,"maxLength":128},"trancheId":{"type":"string","minLength":1,"maxLength":128}},"required":["method","amount","loanRef","trancheId"],"additionalProperties":false}]},"state":{"type":"string","enum":["minted","requested","received","recorded","failed","removed"]},"failure":{"anyOf":[{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_found"},"entity":{"type":"string"},"ref":{"type":"string"}},"required":["code","entity","ref"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"declined"},"reason":{"type":"string"}},"required":["code","reason"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"insufficient_credit"},"requested":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"available":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"retriable":{"type":"boolean"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"ineligible"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"retriable":{"type":"boolean"}},"required":["code","reason"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"draw_in_progress"},"conflict":{"type":"string","const":"key_reused"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"incomplete"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"entities":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["person","organization","loan"]},"ref":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["kind","ref","errors"],"additionalProperties":false}},"detail":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unauthorized"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unavailable"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"wire_mismatch"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false}]},{"type":"null"}]},"transactionRef":{"anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]}},"required":["id","plan","state","failure","transactionRef"],"additionalProperties":false}},"invoice":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"key":{"type":"string","minLength":1,"maxLength":64},"issuedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"}},"required":["id","key","issuedAt"],"additionalProperties":false},{"type":"null"}]}},"required":["id","state","lineIds","amount","payments","invoice"],"additionalProperties":false}}},"required":["orderId","orderNumber","title","lines","offers","collections"],"additionalProperties":false}
invoice.collectionOffersBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
amountinteger (money)required
linesobjectmay be omitted
1 schema note
  • $.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"lines":{"type":"object","properties":{"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"minItems":1}},"required":["saleOrderId","lineIds"]}},"required":["accountId","amount"]}

Output shape documented

array of object

3 schema notes
  • $[].reason runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $[].tranches[].products runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $[].preselect runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"array","items":{"type":"object","properties":{"loanRef":{"type":"string","minLength":1,"maxLength":128},"title":{"type":"string","minLength":1,"maxLength":255},"answer":{"type":"string","enum":["checking","drawable","blocked"]},"available":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}]},"tranches":{"type":"array","items":{"type":"object","properties":{"trancheId":{"type":"string","minLength":1,"maxLength":128},"reference":{"type":"string"},"description":{"type":"string"},"products":{"type":"array","items":{"type":"object","properties":{"productUuid":{"type":"string"},"name":{"type":"string"}},"required":["productUuid","name"],"additionalProperties":false}}},"required":["trancheId","reference","description","products"],"additionalProperties":false}},"preselect":{"anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]}},"required":["loanRef","title","answer","available","reason","tranches","preselect"],"additionalProperties":false}}
invoice.collectOrderBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
orderIdstring (uuid)required
lineIdsarray of string (uuid)required
paymentsarray of object | object | object | objectrequired
5 schema notes
  • $ refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.payments[]|0.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.payments[]|1.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.payments[]|2.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.payments[]|3.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"minItems":1},"payments":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"method":{"type":"string","const":"ach"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["method","amount"]},{"type":"object","properties":{"method":{"type":"string","const":"check"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["method","amount"]},{"type":"object","properties":{"method":{"type":"string","const":"cash"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["method","amount"]},{"type":"object","properties":{"method":{"type":"string","const":"cfi_remit"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"loanRef":{"type":"string","minLength":1,"maxLength":128},"trancheId":{"type":"string","minLength":1,"maxLength":128}},"required":["method","amount","loanRef","trancheId"]}]},"minItems":1}},"required":["orderId","lineIds","payments"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"collectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["collectionId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"order_not_open"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_invoicable"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["code","lineId"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"already_invoiced"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["code","lineId"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"already_selected"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["code","lineId"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_firm_total"}},"required":["code"],"additionalProperties":false}]}]},{"type":"object","properties":{"code":{"type":"string","const":"no_financing"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_ready","already_selected","coverage_mismatch","result_unresolved","not_found","preview_only","not_retryable","not_hand","not_cfi","not_removable","payments_not_received","amount_exceeds_open","already_paid"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
invoice.drawOnLoanBusiness procedure Backend only

Input shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"fresh"},"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"loanRef":{"type":"string","minLength":1,"maxLength":128},"trancheId":{"type":"string","minLength":1,"maxLength":128},"amount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"format":"money"}},"required":["kind","chargeId","loanRef","trancheId"]},{"type":"object","properties":{"kind":{"type":"string","const":"resume"},"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"paymentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","chargeId","paymentId"]}]}

Output shape documented

object | object

3 schema notes
  • $|0.value|0.dealClose|0|0.closeability|1.count refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|0.dealClose|0|0.closeability|2.count refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|0.dealClose|0|0.closeability|3.count refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"oneOf":[{"type":"object","properties":{"state":{"type":"string","const":"recorded"},"paymentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"transactionRef":{"type":"string","minLength":1,"maxLength":128},"dealClose":{"anyOf":[{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"open"},"closeability":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"no_orders"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unfulfilled_orders"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["_tag","count"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"uninvoiced_lines"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["_tag","count"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unsettled_charges"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["_tag","count"],"additionalProperties":false}]}},"required":["_tag","closeability"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"closed"},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","dealId"],"additionalProperties":false}]},{"type":"object","properties":{"_tag":{"type":"string","const":"not_linked"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"close_rejected"},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_accept"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_fulfilled"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_invoiced"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_paid"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unknown_sku"},"sku":{"type":"string"}},"required":["code","sku"],"additionalProperties":false}]}]}},"required":["_tag","error"],"additionalProperties":false}]}},"required":["state","paymentId","transactionRef","dealClose"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"failed"},"paymentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"failure":{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_found"},"entity":{"type":"string"},"ref":{"type":"string"}},"required":["code","entity","ref"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"declined"},"reason":{"type":"string"}},"required":["code","reason"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"insufficient_credit"},"requested":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"available":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"retriable":{"type":"boolean"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"ineligible"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"retriable":{"type":"boolean"}},"required":["code","reason"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"draw_in_progress"},"conflict":{"type":"string","const":"key_reused"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"incomplete"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"entities":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["person","organization","loan"]},"ref":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["kind","ref","errors"],"additionalProperties":false}},"detail":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unauthorized"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unavailable"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"wire_mismatch"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false}]}},"required":["state","paymentId","failure"],"additionalProperties":false}]}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"already_settled"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_relationship"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"duplicate"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_retryable"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_cfi"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"amount_exceeds_open"}},"required":["code"],"additionalProperties":false}]},{"type":"object","properties":{"code":{"type":"string","const":"no_financing"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_found"},"entity":{"type":"string"},"ref":{"type":"string"}},"required":["code","entity","ref"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"declined"},"reason":{"type":"string"}},"required":["code","reason"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"insufficient_credit"},"requested":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"available":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"retriable":{"type":"boolean"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"ineligible"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"retriable":{"type":"boolean"}},"required":["code","reason"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"draw_in_progress"},"conflict":{"type":"string","const":"key_reused"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"incomplete"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"entities":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["person","organization","loan"]},"ref":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["kind","ref","errors"],"additionalProperties":false}},"detail":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unauthorized"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unavailable"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"wire_mismatch"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
invoice.generateInvoiceBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
orderIdstring (uuid)required
lineIdsarray of string (uuid)required
1 schema note
  • $ refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"minItems":1}},"required":["orderId","lineIds"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"invoiceKey":{"type":"string","minLength":1,"maxLength":64}},"required":["chargeId","invoiceKey"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"order_not_open"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_invoicable"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["code","lineId"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"already_invoiced"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["code","lineId"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"already_selected"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["code","lineId"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_firm_total"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
invoice.invoiceSendPreviewBusiness procedure UI supported

Input shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"channel":{"type":"string","enum":["email"]}},"required":["chargeId","channel"]},{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"channel":{"type":"string","enum":["sms"]}},"required":["chargeId","channel"]}]}

Output shape documented

object | object | object | object

2 schema notes
  • $|0|0.recipient.address refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0|1.recipient.address refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"oneOf":[{"type":"object","properties":{"channel":{"type":"string","enum":["email"]},"_tag":{"type":"string","const":"ready"},"recipient":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"address":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"required":["name","address"],"additionalProperties":false},"subject":{"type":"string","minLength":1},"html":{"type":"string","minLength":1}},"required":["channel","_tag","recipient","subject","html"],"additionalProperties":false},{"type":"object","properties":{"channel":{"type":"string","enum":["email"]},"_tag":{"type":"string","const":"refused"},"refusal":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_contact_email"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unbranded"}},"required":["code"],"additionalProperties":false}]}]},"recipient":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"address":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"required":["name","address"],"additionalProperties":false},{"type":"null"}]}},"required":["channel","_tag","refusal","recipient"],"additionalProperties":false}]},{"oneOf":[{"type":"object","properties":{"channel":{"type":"string","enum":["sms"]},"_tag":{"type":"string","const":"ready"},"recipient":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"address":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"}},"required":["name","address"],"additionalProperties":false},"body":{"type":"string","minLength":1}},"required":["channel","_tag","recipient","body"],"additionalProperties":false},{"type":"object","properties":{"channel":{"type":"string","enum":["sms"]},"_tag":{"type":"string","const":"refused"},"refusal":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_phone"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_contact_email"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unbranded"}},"required":["code"],"additionalProperties":false}]}]},"recipient":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"address":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"}},"required":["name","address"],"additionalProperties":false},{"type":"null"}]}},"required":["channel","_tag","refusal","recipient"],"additionalProperties":false}]}]}
invoice.issueCreditBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
chargeIdstring (uuid)required
amountinteger (money)required
Full logical schema
{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"amount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"format":"money"}},"required":["chargeId","amount"]}

Output shape documented

object | object

3 schema notes
  • $|0.value.dealClose|0|0.closeability|1.count refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.dealClose|0|0.closeability|2.count refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.dealClose|0|0.closeability|3.count refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"creditMemoId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dealClose":{"anyOf":[{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"open"},"closeability":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"no_orders"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unfulfilled_orders"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["_tag","count"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"uninvoiced_lines"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["_tag","count"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unsettled_charges"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["_tag","count"],"additionalProperties":false}]}},"required":["_tag","closeability"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"closed"},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","dealId"],"additionalProperties":false}]},{"type":"object","properties":{"_tag":{"type":"string","const":"not_linked"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"close_rejected"},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_accept"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_fulfilled"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_invoiced"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_paid"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unknown_sku"},"sku":{"type":"string"}},"required":["code","sku"],"additionalProperties":false}]}]}},"required":["_tag","error"],"additionalProperties":false}]}},"required":["creditMemoId","dealClose"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"amount_exceeds_open"},"open":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["code","open"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"duplicate"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
invoice.orderSummaryBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
orderIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["accountId","orderId"]}

Output shape documented

FieldLogical typePresence
orderIdstring (uuid)required
titlestringrequired
orderNamestringrequired
accountNamestringrequired
financingobject | object | object | object | object | object | nullrequired
moneyobjectrequired
linesarray of objectrequired
offersarray of objectrequired
collectionsarray of objectrequired
historyarray of objectrequired
prepayobjectrequired
workHeldarray of "read" | "revisePlan" | "fulfill"required
19 schema notes
  • $.money.invoices[].lastSend runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.money.invoices[].channels.email.destination refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.money.invoices[].channels runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.money.invoices[].payments[].plan|0.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.money.invoices[].payments[].plan|1.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.money.invoices[].payments[].plan|2.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.money.invoices[].payments[].plan|3.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.money.invoices[].returned runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[].workOffered runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[].cancelItem runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[].returnState runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].reason runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].tranches[].products runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].preselect runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.collections[].payments[].plan|0.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.collections[].payments[].plan|1.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.collections[].payments[].plan|2.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.collections[].payments[].plan|3.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.workHeld runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"title":{"type":"string","minLength":1,"maxLength":255},"orderName":{"type":"string","minLength":1,"maxLength":255},"accountName":{"type":"string","minLength":1,"maxLength":255},"financing":{"anyOf":[{"oneOf":[{"type":"object","properties":{"state":{"type":"string","const":"unknown"}},"required":["state"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"none"}},"required":["state"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"draft"}},"required":["state"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"pending"},"requested":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["state"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"available"},"available":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["state","available"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"declined"}},"required":["state"],"additionalProperties":false}]},{"type":"null"}]},"money":{"type":"object","properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"paid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"credits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"balance":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"dueNow":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"dueLater":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"unbilled":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"pending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"status":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":255},"tone":{"type":"string","enum":["default","info","success","warning","destructive"]}},"required":["label","tone"],"additionalProperties":false},"fulfillmentLabel":{"type":"string","minLength":1,"maxLength":255},"invoices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reference":{"type":"string","minLength":1,"maxLength":255},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"paid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"balance":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"payable":{"oneOf":[{"type":"object","properties":{"by":{"type":"string","const":"lines"},"lineIds":{"type":"array","prefixItems":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}],"minItems":1,"items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["by","lineIds","amount"],"additionalProperties":false},{"type":"object","properties":{"by":{"type":"string","const":"none"}},"required":["by"],"additionalProperties":false}]},"status":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":255},"tone":{"type":"string","enum":["default","info","success","warning","destructive"]}},"required":["label","tone"],"additionalProperties":false},"dueLabel":{"type":"string","minLength":1,"maxLength":255},"paidStanding":{"type":"string","enum":["unpaid","partiallyPaid","fullyPaid"]},"paidStandingLabel":{"type":"string","minLength":1,"maxLength":255},"lastSend":{"anyOf":[{"type":"object","properties":{"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"channel":{"type":"string","enum":["email","sms","in_app"]},"state":{"type":"string","enum":["queued","sent_email","sent_sms","delivered","bounced","failed"]},"status":{"type":"string","minLength":1,"maxLength":255},"notDelivered":{"type":"boolean"}},"required":["at","channel","state","status","notDelivered"],"additionalProperties":false},{"type":"null"}]},"channels":{"type":"object","properties":{"email":{"type":"object","properties":{"destination":{"anyOf":[{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"lastSend":{"anyOf":[{"type":"object","properties":{"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"channel":{"type":"string","enum":["email","sms","in_app"]},"state":{"type":"string","enum":["queued","sent_email","sent_sms","delivered","bounced","failed"]},"status":{"type":"string","minLength":1,"maxLength":255},"notDelivered":{"type":"boolean"}},"required":["at","channel","state","status","notDelivered"],"additionalProperties":false},{"type":"null"}]}},"required":["destination","lastSend"],"additionalProperties":false},"sms":{"type":"object","properties":{"destination":{"anyOf":[{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},{"type":"null"}]},"lastSend":{"anyOf":[{"type":"object","properties":{"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"channel":{"type":"string","enum":["email","sms","in_app"]},"state":{"type":"string","enum":["queued","sent_email","sent_sms","delivered","bounced","failed"]},"status":{"type":"string","minLength":1,"maxLength":255},"notDelivered":{"type":"boolean"}},"required":["at","channel","state","status","notDelivered"],"additionalProperties":false},{"type":"null"}]}},"required":["destination","lastSend"],"additionalProperties":false}},"required":["email","sms"],"additionalProperties":false},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1,"maxLength":255},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"status":{"type":"string","enum":["minted","requested","received","recorded","failed","removed"]},"plan":{"anyOf":[{"oneOf":[{"type":"object","properties":{"method":{"type":"string","const":"ach"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["method","amount"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","const":"check"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["method","amount"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","const":"cash"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["method","amount"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","const":"cfi_remit"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"loanRef":{"type":"string","minLength":1,"maxLength":128},"trancheId":{"type":"string","minLength":1,"maxLength":128}},"required":["method","amount","loanRef","trancheId"],"additionalProperties":false}]},{"type":"null"}]},"failure":{"anyOf":[{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_found"},"entity":{"type":"string"},"ref":{"type":"string"}},"required":["code","entity","ref"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"declined"},"reason":{"type":"string"}},"required":["code","reason"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"insufficient_credit"},"requested":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"available":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"retriable":{"type":"boolean"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"ineligible"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"retriable":{"type":"boolean"}},"required":["code","reason"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"draw_in_progress"},"conflict":{"type":"string","const":"key_reused"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"incomplete"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"entities":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["person","organization","loan"]},"ref":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["kind","ref","errors"],"additionalProperties":false}},"detail":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unauthorized"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unavailable"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"wire_mismatch"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false}]},{"type":"null"}]},"transactionRef":{"anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]}},"required":["id","label","amount","status","plan","failure","transactionRef"],"additionalProperties":false}},"returned":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"paidNet":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["id","reference","amount","paid","balance","payable","status","dueLabel","paidStanding","paidStandingLabel","lastSend","channels","payments","returned","paidNet"],"additionalProperties":false}}},"required":["total","paid","credits","balance","dueNow","dueLater","unbilled","pending","status","fulfillmentLabel","invoices"],"additionalProperties":false},"lines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"quantityLabel":{"type":"string","minLength":1,"maxLength":255},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"fulfillmentLabel":{"type":"string","minLength":1,"maxLength":255},"paymentStatus":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":255},"tone":{"type":"string","enum":["default","info","success","warning","destructive"]}},"required":["label","tone"],"additionalProperties":false},"collectionId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"chargeId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"item":{"type":"string","minLength":1,"maxLength":255},"itemSub":{"type":"string","minLength":1,"maxLength":255},"quantity":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"paid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"outstanding":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"paidAt":{"anyOf":[{"type":"string","format":"date-time","x-wire-kind":"Instant"},{"type":"null"}]},"collectable":{"type":"boolean"},"fulfillStep":{"type":"string","enum":["record","schedule","none"]},"collectStep":{"type":"string","enum":["collect","view","none"]},"payment":{"type":"string","enum":["paid","pendingPayment"]},"paymentLabel":{"type":"string","minLength":1,"maxLength":255},"status":{"type":"string","enum":["cancelled","returnInFlight","pendingFulfillment","readyToInvoice","pendingPayment","paid"]},"statusLabel":{"type":"string","minLength":1,"maxLength":255},"workOffered":{"type":"array","items":{"type":"string","enum":["read","revisePlan","fulfill"]}},"cancelItem":{"anyOf":[{"type":"object","properties":{"loanRef":{"type":"string","minLength":1,"maxLength":128},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"cancelsDelivery":{"type":"boolean"}},"required":["loanRef","amount","cancelsDelivery"],"additionalProperties":false},{"type":"null"}]},"returnState":{"type":"string","enum":["none","inFlight","returned"]}},"required":["id","name","quantityLabel","amount","fulfillmentLabel","paymentStatus","collectionId","chargeId","item","itemSub","quantity","paid","outstanding","paidAt","collectable","fulfillStep","collectStep","payment","paymentLabel","status","statusLabel","workOffered","cancelItem","returnState"],"additionalProperties":false}},"offers":{"type":"array","items":{"type":"object","properties":{"loanRef":{"type":"string","minLength":1,"maxLength":128},"title":{"type":"string","minLength":1,"maxLength":255},"answer":{"type":"string","enum":["checking","drawable","blocked"]},"available":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}]},"tranches":{"type":"array","items":{"type":"object","properties":{"trancheId":{"type":"string","minLength":1,"maxLength":128},"reference":{"type":"string"},"description":{"type":"string"},"products":{"type":"array","items":{"type":"object","properties":{"productUuid":{"type":"string"},"name":{"type":"string"}},"required":["productUuid","name"],"additionalProperties":false}}},"required":["trancheId","reference","description","products"],"additionalProperties":false}},"preselect":{"anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]}},"required":["loanRef","title","answer","available","reason","tranches","preselect"],"additionalProperties":false}},"collections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"state":{"anyOf":[{"type":"string","const":"collecting"},{"type":"string","const":"completed"}]},"lineIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"payments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"plan":{"oneOf":[{"type":"object","properties":{"method":{"type":"string","const":"ach"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["method","amount"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","const":"check"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["method","amount"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","const":"cash"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["method","amount"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","const":"cfi_remit"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"loanRef":{"type":"string","minLength":1,"maxLength":128},"trancheId":{"type":"string","minLength":1,"maxLength":128}},"required":["method","amount","loanRef","trancheId"],"additionalProperties":false}]},"state":{"type":"string","enum":["minted","requested","received","recorded","failed","removed"]},"failure":{"anyOf":[{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_found"},"entity":{"type":"string"},"ref":{"type":"string"}},"required":["code","entity","ref"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"declined"},"reason":{"type":"string"}},"required":["code","reason"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"insufficient_credit"},"requested":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"available":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"retriable":{"type":"boolean"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"ineligible"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"retriable":{"type":"boolean"}},"required":["code","reason"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"draw_in_progress"},"conflict":{"type":"string","const":"key_reused"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"incomplete"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"entities":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["person","organization","loan"]},"ref":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["kind","ref","errors"],"additionalProperties":false}},"detail":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unauthorized"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unavailable"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"wire_mismatch"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false}]},{"type":"null"}]},"transactionRef":{"anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]}},"required":["id","plan","state","failure","transactionRef"],"additionalProperties":false}},"invoice":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"key":{"type":"string","minLength":1,"maxLength":64},"issuedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"}},"required":["id","key","issuedAt"],"additionalProperties":false},{"type":"null"}]}},"required":["id","state","lineIds","amount","payments","invoice"],"additionalProperties":false}},"history":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":255},"label":{"type":"string","minLength":1,"maxLength":255},"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"}},"required":["id","label","at"],"additionalProperties":false}},"prepay":{"type":"object","properties":{"lineIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"afterPaid":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"afterBalance":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["lineIds","amount","afterPaid","afterBalance"],"additionalProperties":false},"workHeld":{"type":"array","items":{"type":"string","enum":["read","revisePlan","fulfill"]}}},"required":["orderId","title","orderName","accountName","financing","money","lines","offers","collections","history","prepay","workHeld"],"additionalProperties":false}
invoice.recordPaymentBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
targetobject | objectrequired
amountinteger (money)required
method"check" | "cash" | "ach"required
Full logical schema
{"type":"object","properties":{"target":{"oneOf":[{"type":"object","properties":{"to":{"type":"string","const":"charge"},"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["to","chargeId"]},{"type":"object","properties":{"to":{"type":"string","const":"account"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["to","accountId"]}]},"amount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"format":"money"},"method":{"type":"string","enum":["check","cash","ach"]}},"required":["target","amount","method"]}

Output shape documented

object | object

3 schema notes
  • $|0.value.dealClose|0|0.closeability|1.count refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.dealClose|0|0.closeability|2.count refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.dealClose|0|0.closeability|3.count refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"paymentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dealClose":{"anyOf":[{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"open"},"closeability":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"no_orders"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unfulfilled_orders"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["_tag","count"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"uninvoiced_lines"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["_tag","count"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unsettled_charges"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["_tag","count"],"additionalProperties":false}]}},"required":["_tag","closeability"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"closed"},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","dealId"],"additionalProperties":false}]},{"type":"object","properties":{"_tag":{"type":"string","const":"not_linked"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"close_rejected"},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_accept"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_fulfilled"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_invoiced"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_paid"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unknown_sku"},"sku":{"type":"string"}},"required":["code","sku"],"additionalProperties":false}]}]}},"required":["_tag","error"],"additionalProperties":false}]}},"required":["paymentId","dealClose"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_hand"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"amount_exceeds_open"},"open":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"duplicate"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
invoice.replaceCollectionBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
orderIdstring (uuid)required
collectionIdstring (uuid)required
removePaymentIdsarray of string (uuid)required
paymentsarray of object | object | object | objectrequired
4 schema notes
  • $.payments[]|0.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.payments[]|1.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.payments[]|2.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.payments[]|3.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"collectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"removePaymentIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"payments":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"method":{"type":"string","const":"ach"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["method","amount"]},{"type":"object","properties":{"method":{"type":"string","const":"check"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["method","amount"]},{"type":"object","properties":{"method":{"type":"string","const":"cash"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["method","amount"]},{"type":"object","properties":{"method":{"type":"string","const":"cfi_remit"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"loanRef":{"type":"string","minLength":1,"maxLength":128},"trancheId":{"type":"string","minLength":1,"maxLength":128}},"required":["method","amount","loanRef","trancheId"]}]}}},"required":["orderId","collectionId","removePaymentIds","payments"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"collectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["collectionId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"order_not_open"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_invoicable"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["code","lineId"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"already_invoiced"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["code","lineId"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"already_selected"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["code","lineId"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_firm_total"}},"required":["code"],"additionalProperties":false}]}]},{"type":"object","properties":{"code":{"type":"string","const":"no_financing"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_ready","already_selected","coverage_mismatch","result_unresolved","not_found","preview_only","not_retryable","not_hand","not_cfi","not_removable","payments_not_received","amount_exceeds_open","already_paid"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
invoice.resumeCollectionBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
orderIdstring (uuid)required
collectionIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"collectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["orderId","collectionId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"collectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["collectionId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"order_not_open"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_invoicable"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["code","lineId"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"already_invoiced"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["code","lineId"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"already_selected"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["code","lineId"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_firm_total"}},"required":["code"],"additionalProperties":false}]}]},{"type":"object","properties":{"code":{"type":"string","const":"no_financing"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_ready","already_selected","coverage_mismatch","result_unresolved","not_found","preview_only","not_retryable","not_hand","not_cfi","not_removable","payments_not_received","amount_exceeds_open","already_paid"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
invoice.sendInvoiceEmailBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
chargeIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["chargeId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"notificationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["notificationId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_contact_email"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unbranded"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
invoice.sendInvoiceTextBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
chargeIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["chargeId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"notificationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["notificationId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_phone"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_contact_email"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unbranded"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}

invoiceComposer

Invoice composition and payment entries

Invoice-ledger views and charge, retry, and payment-removal result fields.

invoiceComposer.boardBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
chargeIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["chargeId"]}

Output shape documented

FieldLogical typePresence
chargeIdstring (uuid)required
chargeinteger (money)required
creditedinteger (money)required
ledgerOpeninteger (money)required
collectibleinteger (money)required
recordedinteger (money)required
offersarray of objectrequired
rowsarray of objectrequired
4 schema notes
  • $.offers[].reason runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].tranches[].products runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.offers[].preselect runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].failure.sentence runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"charge":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"credited":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"ledgerOpen":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"collectible":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"recorded":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"offers":{"type":"array","items":{"type":"object","properties":{"loanRef":{"type":"string","minLength":1,"maxLength":128},"title":{"type":"string","minLength":1,"maxLength":255},"answer":{"type":"string","enum":["checking","drawable","blocked"]},"available":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string","maxLength":5000},{"type":"null"}]},"tranches":{"type":"array","items":{"type":"object","properties":{"trancheId":{"type":"string","minLength":1,"maxLength":128},"reference":{"type":"string"},"description":{"type":"string"},"products":{"type":"array","items":{"type":"object","properties":{"productUuid":{"type":"string"},"name":{"type":"string"}},"required":["productUuid","name"],"additionalProperties":false}}},"required":["trancheId","reference","description","products"],"additionalProperties":false}},"preselect":{"anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]}},"required":["loanRef","title","answer","available","reason","tranches","preselect"],"additionalProperties":false}},"rows":{"type":"array","items":{"type":"object","properties":{"paymentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"method":{"type":"string","enum":["check","cash","ach","cfi_remit"]},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"state":{"type":"string","enum":["minted","requested","received","recorded","failed","removed"]},"loanRef":{"anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]},"trancheId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128},{"type":"null"}]},"failure":{"anyOf":[{"type":"object","properties":{"outcome":{"type":"string","enum":["indeterminate","verdict"]},"sentence":{"type":"string","maxLength":5000}},"required":["outcome","sentence"],"additionalProperties":false},{"type":"null"}]}},"required":["paymentId","method","amount","state","loanRef","trancheId","failure"],"additionalProperties":false}}},"required":["chargeId","charge","credited","ledgerOpen","collectible","recorded","offers","rows"],"additionalProperties":false}
invoiceComposer.chargeInvoiceBusiness procedure UI supported

Input shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"method":{"type":"string","const":"cfi_remit"},"amount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"format":"money"},"loanRef":{"type":"string","minLength":1,"maxLength":128},"trancheId":{"type":"string","minLength":1,"maxLength":128}},"required":["chargeId","method","amount","loanRef","trancheId"]},{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"method":{"type":"string","enum":["check","cash","ach"]},"amount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"format":"money"}},"required":["chargeId","method","amount"]}]}

Output shape documented

object | object

3 schema notes
  • $|0.value.dealClose|0|0.closeability|1.count refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.dealClose|0|0.closeability|2.count refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.dealClose|0|0.closeability|3.count refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"paymentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dealClose":{"anyOf":[{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"open"},"closeability":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"no_orders"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unfulfilled_orders"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["_tag","count"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"uninvoiced_lines"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["_tag","count"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unsettled_charges"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["_tag","count"],"additionalProperties":false}]}},"required":["_tag","closeability"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"closed"},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","dealId"],"additionalProperties":false}]},{"type":"object","properties":{"_tag":{"type":"string","const":"not_linked"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"close_rejected"},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_accept"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_fulfilled"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_invoiced"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_paid"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unknown_sku"},"sku":{"type":"string"}},"required":["code","sku"],"additionalProperties":false}]}]}},"required":["_tag","error"],"additionalProperties":false}]}},"required":["paymentId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"already_settled"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_relationship"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"duplicate"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_retryable"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_cfi"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"amount_exceeds_open"}},"required":["code"],"additionalProperties":false}]},{"type":"object","properties":{"code":{"type":"string","const":"no_financing"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_found"},"entity":{"type":"string"},"ref":{"type":"string"}},"required":["code","entity","ref"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"declined"},"reason":{"type":"string"}},"required":["code","reason"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"insufficient_credit"},"requested":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"available":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"retriable":{"type":"boolean"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"ineligible"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"retriable":{"type":"boolean"}},"required":["code","reason"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"draw_in_progress"},"conflict":{"type":"string","const":"key_reused"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"incomplete"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"entities":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["person","organization","loan"]},"ref":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["kind","ref","errors"],"additionalProperties":false}},"detail":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unauthorized"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unavailable"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"wire_mismatch"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false}]}]},{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_hand"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"amount_exceeds_open"},"open":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"duplicate"}},"required":["code"],"additionalProperties":false}]}]},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"row_not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_retryable"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_removable"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"already_terminal"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
invoiceComposer.removePaymentBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
chargeIdstring (uuid)required
paymentIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"paymentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["chargeId","paymentId"]}

Output shape documented

object | object

3 schema notes
  • $|0.value.dealClose|0|0.closeability|1.count refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.dealClose|0|0.closeability|2.count refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.dealClose|0|0.closeability|3.count refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"paymentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dealClose":{"anyOf":[{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"open"},"closeability":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"no_orders"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unfulfilled_orders"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["_tag","count"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"uninvoiced_lines"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["_tag","count"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unsettled_charges"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["_tag","count"],"additionalProperties":false}]}},"required":["_tag","closeability"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"closed"},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","dealId"],"additionalProperties":false}]},{"type":"object","properties":{"_tag":{"type":"string","const":"not_linked"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"close_rejected"},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_accept"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_fulfilled"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_invoiced"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_paid"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unknown_sku"},"sku":{"type":"string"}},"required":["code","sku"],"additionalProperties":false}]}]}},"required":["_tag","error"],"additionalProperties":false}]}},"required":["paymentId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"already_settled"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_relationship"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"duplicate"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_retryable"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_cfi"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"amount_exceeds_open"}},"required":["code"],"additionalProperties":false}]},{"type":"object","properties":{"code":{"type":"string","const":"no_financing"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_found"},"entity":{"type":"string"},"ref":{"type":"string"}},"required":["code","entity","ref"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"declined"},"reason":{"type":"string"}},"required":["code","reason"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"insufficient_credit"},"requested":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"available":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"retriable":{"type":"boolean"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"ineligible"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"retriable":{"type":"boolean"}},"required":["code","reason"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"draw_in_progress"},"conflict":{"type":"string","const":"key_reused"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"incomplete"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"entities":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["person","organization","loan"]},"ref":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["kind","ref","errors"],"additionalProperties":false}},"detail":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unauthorized"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unavailable"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"wire_mismatch"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false}]}]},{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_hand"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"amount_exceeds_open"},"open":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"duplicate"}},"required":["code"],"additionalProperties":false}]}]},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"row_not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_retryable"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_removable"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"already_terminal"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
invoiceComposer.retryPaymentBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
chargeIdstring (uuid)required
paymentIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"chargeId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"paymentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["chargeId","paymentId"]}

Output shape documented

object | object

3 schema notes
  • $|0.value.dealClose|0|0.closeability|1.count refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.dealClose|0|0.closeability|2.count refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.dealClose|0|0.closeability|3.count refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"paymentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dealClose":{"anyOf":[{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"open"},"closeability":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"no_orders"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unfulfilled_orders"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["_tag","count"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"uninvoiced_lines"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["_tag","count"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unsettled_charges"},"count":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["_tag","count"],"additionalProperties":false}]}},"required":["_tag","closeability"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"closed"},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","dealId"],"additionalProperties":false}]},{"type":"object","properties":{"_tag":{"type":"string","const":"not_linked"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"close_rejected"},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_accept"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_fulfilled"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_invoiced"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_paid"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unknown_sku"},"sku":{"type":"string"}},"required":["code","sku"],"additionalProperties":false}]}]}},"required":["_tag","error"],"additionalProperties":false}]}},"required":["paymentId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"already_settled"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_relationship"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"duplicate"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_retryable"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_cfi"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"amount_exceeds_open"}},"required":["code"],"additionalProperties":false}]},{"type":"object","properties":{"code":{"type":"string","const":"no_financing"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_found"},"entity":{"type":"string"},"ref":{"type":"string"}},"required":["code","entity","ref"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"declined"},"reason":{"type":"string"}},"required":["code","reason"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"insufficient_credit"},"requested":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"available":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"retriable":{"type":"boolean"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"ineligible"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"retriable":{"type":"boolean"}},"required":["code","reason"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"draw_in_progress"},"conflict":{"type":"string","const":"key_reused"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"incomplete"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]}},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"entities":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["person","organization","loan"]},"ref":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}},"required":["kind","ref","errors"],"additionalProperties":false}},"detail":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unauthorized"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unavailable"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"wire_mismatch"},"detail":{"type":"string"}},"required":["code","detail"],"additionalProperties":false}]}]},{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_hand"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"amount_exceeds_open"},"open":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"duplicate"}},"required":["code"],"additionalProperties":false}]}]},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"row_not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_retryable"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_removable"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"already_terminal"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}

invoices

Invoice search

Invoice search filters, paging, facets, and result rows.

invoices.searchWithFacetsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
matchobject | objectmay be omitted
lens"active" | "all" | "unpaid"may be omitted
sort"recentlyIssued" | "oldestFirst"may be omitted
accountIdstring (uuid) | nullmay be omitted
limitintegermay be omitted
cursorstring | nullmay be omitted
8 schema notes
  • $.match|1.q refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.match runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lens runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sort runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.accountId runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"match":{"oneOf":[{"type":"object","properties":{"by":{"type":"string","const":"none"}},"required":["by"]},{"type":"object","properties":{"by":{"type":"string","const":"text"},"q":{"type":"string","minLength":1}},"required":["by","q"]}]},"lens":{"type":"string","enum":["active","all","unpaid"]},"sort":{"type":"string","enum":["recentlyIssued","oldestFirst"]},"accountId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"limit":{"type":"integer","minimum":1,"maximum":200},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
totalintegerrequired
nextCursorstring | nullrequired
totalsobjectrequired
facetsobjectrequired
2 schema notes
  • $.rows[].accountEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].invoiceId runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountName":{"type":"string","minLength":1,"maxLength":255},"contactName":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"farmName":{"type":"string","minLength":1,"maxLength":255},"accountEmail":{"anyOf":[{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"accountTel":{"anyOf":[{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},{"type":"null"}]},"location":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"invoiceId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"orderNumber":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"orderDate":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"invoiceTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"invoiceSplit":{"type":"object","properties":{"ready":{"type":"integer","minimum":0,"maximum":9007199254740991},"generated":{"type":"integer","minimum":0,"maximum":9007199254740991},"paid":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["ready","generated","paid"],"additionalProperties":false},"latestIssuedAt":{"anyOf":[{"type":"string","format":"date-time","x-wire-kind":"Instant"},{"type":"null"}]},"paymentStatus":{"type":"string","enum":["paymentPending","paymentCompleted"]},"paymentMethods":{"type":"array","items":{"type":"string","enum":["check","cash","ach","cfi_remit"]}},"financing":{"anyOf":[{"oneOf":[{"type":"object","properties":{"state":{"type":"string","const":"unknown"}},"required":["state"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"none"}},"required":["state"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"draft"}},"required":["state"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"pending"},"requested":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["state"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"available"},"available":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["state","available"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"declined"}},"required":["state"],"additionalProperties":false}]},{"type":"null"}]}},"required":["accountId","accountName","contactName","farmName","accountEmail","accountTel","location","orderId","invoiceId","orderNumber","orderDate","invoiceTotal","invoiceSplit","latestIssuedAt","paymentStatus","paymentMethods","financing"],"additionalProperties":false}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"totals":{"type":"object","properties":{"paymentPending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"paymentCompleted":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["paymentPending","paymentCompleted"],"additionalProperties":false},"facets":{"type":"object","properties":{"active":{"type":"integer","minimum":0,"maximum":9007199254740991},"all":{"type":"integer","minimum":0,"maximum":9007199254740991},"unpaid":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["active","all","unpaid"],"additionalProperties":false}},"required":["rows","total","nextCursor","totals","facets"],"additionalProperties":false}

lineFulfillment

Order-line fulfillment

Fulfillment queue rows and plan, movement, and cancellation results for order lines.

lineFulfillment.cancelBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
lineFulfillmentIdstring (uuid)required
reasonstringrequired
Full logical schema
{"type":"object","properties":{"lineFulfillmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reason":{"type":"string","minLength":1,"maxLength":5000}},"required":["lineFulfillmentId","reason"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"lineFulfillmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["lineFulfillmentId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_open","line_billed"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
lineFulfillment.fulfillBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
lineFulfillmentIdstring (uuid)required
sourceWarehouseIdstring (uuid)required
movedobjectrequired
shipmentDetailsobjectmay be omitted
3 schema notes
  • $.moved.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.shipmentDetails refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.shipmentDetails.eta runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"lineFulfillmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sourceWarehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"moved":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"]},"shipmentDetails":{"type":"object","properties":{"carrier":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"tracking":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"driver":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"driverPhone":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"vehicle":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"eta":{"anyOf":[{"type":"string","format":"date-time","x-zod-type":"date"},{"type":"null"}]}},"additionalProperties":false}},"required":["lineFulfillmentId","sourceWarehouseId","moved"]}

Output shape documented

object | object

2 schema notes
  • $|1.error|1|11.value refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|1|11.increment refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"lineFulfillmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"remainderLineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"consumptionIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"shipmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["lineFulfillmentId","remainderLineFulfillmentId","consumptionIds","shipmentId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_open"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"order_not_open"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"line_not_on_order"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unknown_catalog_item"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"warehouse_unready"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"wrong_pickup_warehouse"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"insufficient_stock"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"return_in_flight"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_a_delivery"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_outbound"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"delivery_tracking_off"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"off_increment"},"value":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"increment":{"type":"string","format":"decimal","x-wire-kind":"Amount"}},"required":["code","value","increment"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"movement_exceeds_open"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"movement_does_not_complete_open"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"children_do_not_conserve_parent"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
lineFulfillment.growerByOrderBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
dealerstring (uuid)required
orderIdstring (uuid)required
fulfillmentIdstring (uuid)may be omitted
Full logical schema
{"type":"object","properties":{"dealer":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"fulfillmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealer","orderId"],"additionalProperties":false}

Output shape documented

FieldLogical typePresence
rowsarray of object | object | object | objectrequired
totalintegerrequired
nextCursorstring | nullrequired
8 schema notes
  • $.rows[]|0.qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|2.qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|2.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|3.qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|3.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"open"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"parentLineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"mode":{"type":"string","enum":["delivery","pickup","notRecorded"]},"field":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":255},"crop":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]},"acreage":{"type":"number","exclusiveMinimum":0,"maximum":200000,"format":"number"},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false}},"required":["id","label","crop","acreage","address"],"additionalProperties":false},{"type":"null"}]},"bySupplier":{"type":"boolean"},"windowRequestable":{"type":"boolean"},"standing":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"scheduled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"dispatched"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"delivered"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pickedUp"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"fulfilled"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cancelled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"superseded"}},"required":["kind"],"additionalProperties":false}]}},"required":["_tag","id","lineId","parentLineFulfillmentId","qty","timeWindow","mode","field","bySupplier","windowRequestable","standing"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"fulfilled"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"parentLineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"mode":{"type":"string","enum":["delivery","pickup","notRecorded"]},"field":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":255},"crop":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]},"acreage":{"type":"number","exclusiveMinimum":0,"maximum":200000,"format":"number"},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false}},"required":["id","label","crop","acreage","address"],"additionalProperties":false},{"type":"null"}]},"bySupplier":{"type":"boolean"},"windowRequestable":{"type":"boolean"},"standing":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"scheduled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"dispatched"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"delivered"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pickedUp"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"fulfilled"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cancelled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"superseded"}},"required":["kind"],"additionalProperties":false}]}},"required":["_tag","id","lineId","parentLineFulfillmentId","qty","timeWindow","mode","field","bySupplier","windowRequestable","standing"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"cancelled"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"parentLineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"cancelledAt":{"type":"string","format":"date-time","x-zod-type":"date"},"mode":{"type":"string","enum":["delivery","pickup","notRecorded"]},"field":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":255},"crop":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]},"acreage":{"type":"number","exclusiveMinimum":0,"maximum":200000,"format":"number"},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false}},"required":["id","label","crop","acreage","address"],"additionalProperties":false},{"type":"null"}]},"bySupplier":{"type":"boolean"},"windowRequestable":{"type":"boolean"},"standing":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"scheduled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"dispatched"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"delivered"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pickedUp"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"fulfilled"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cancelled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"superseded"}},"required":["kind"],"additionalProperties":false}]}},"required":["_tag","id","lineId","parentLineFulfillmentId","qty","timeWindow","cancelledAt","mode","field","bySupplier","windowRequestable","standing"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"superseded"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"parentLineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"mode":{"type":"string","enum":["delivery","pickup","notRecorded"]},"field":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":255},"crop":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]},"acreage":{"type":"number","exclusiveMinimum":0,"maximum":200000,"format":"number"},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false}},"required":["id","label","crop","acreage","address"],"additionalProperties":false},{"type":"null"}]},"bySupplier":{"type":"boolean"},"windowRequestable":{"type":"boolean"},"standing":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"scheduled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"dispatched"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"delivered"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pickedUp"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"fulfilled"},"on":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","on"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cancelled"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"superseded"}},"required":["kind"],"additionalProperties":false}]}},"required":["_tag","id","lineId","parentLineFulfillmentId","qty","timeWindow","mode","field","bySupplier","windowRequestable","standing"],"additionalProperties":false}]}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["rows","total","nextCursor"],"additionalProperties":false}
lineFulfillment.indexQueueBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
termstringmay be omitted
orderstring (uuid)may be omitted
mode"all" | "delivery" | "pickup"may be omitted
timing"open" | "all" | "pastDue" | "needsWindow" | "thisWeek" | "later" | "partial" | "fulfilled"may be omitted
limitintegermay be omitted
cursorstring | nullmay be omitted
sort"schedule"may be omitted
7 schema notes
  • $.term runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.mode runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.timing runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sort runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"term":{"type":"string","maxLength":120},"order":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"mode":{"type":"string","enum":["all","delivery","pickup"]},"timing":{"type":"string","enum":["open","all","pastDue","needsWindow","thisWeek","later","partial","fulfilled"]},"limit":{"type":"integer","minimum":1,"maximum":200},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"sort":{"type":"string","const":"schedule"}}}

Output shape documented

FieldLogical typePresence
rowsarray of object | objectrequired
totalintegerrequired
nextCursorstring | nullrequired
facetsobjectrequired
32 schema notes
  • $.rows[]|0.accountEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.orderedQuantity refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.movedQuantity refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.remainingQuantity refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.blendRecipe.components[].form|0.analysis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.blendRecipe.components[].form|0.analysis.n refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.blendRecipe.components[].form|0.analysis.p2o5 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.blendRecipe.components[].form|0.analysis.k2o refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.blendRecipe.components[].form|0.analysis.s refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.blendRecipe.components[].form|1.analysis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.blendRecipe.components[].form|1.analysis.n refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.blendRecipe.components[].form|1.analysis.p2o5 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.blendRecipe.components[].form|1.analysis.k2o refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.blendRecipe.components[].form|1.analysis.s refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|0.blendRecipe.components[].form|1.lbPerGal refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.accountEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.orderedQuantity refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.movedQuantity refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.remainingQuantity refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.blendRecipe.components[].form|0.analysis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.blendRecipe.components[].form|0.analysis.n refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.blendRecipe.components[].form|0.analysis.p2o5 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.blendRecipe.components[].form|0.analysis.k2o refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.blendRecipe.components[].form|0.analysis.s refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.blendRecipe.components[].form|1.analysis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.blendRecipe.components[].form|1.analysis.n refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.blendRecipe.components[].form|1.analysis.p2o5 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.blendRecipe.components[].form|1.analysis.k2o refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.blendRecipe.components[].form|1.analysis.s refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[]|1.blendRecipe.components[].form|1.lbPerGal refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"arm":{"type":"string","const":"own"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"mode":{"type":"string","enum":["delivery","pickup"]},"modes":{"type":"array","items":{"type":"string","enum":["delivery","pickup"]},"minItems":1},"group":{"oneOf":[{"type":"object","properties":{"mode":{"type":"string","const":"pickup"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1,"maxLength":255}},"required":["mode","warehouseId","label"],"additionalProperties":false},{"type":"object","properties":{"mode":{"type":"string","const":"delivery"},"destinationFieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1}},"required":["mode","destinationFieldId","label"],"additionalProperties":false}]},"orderLabel":{"type":"string","minLength":1,"maxLength":255},"orderNumber":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"accountName":{"type":"string","minLength":1,"maxLength":255},"contactName":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"farmName":{"type":"string","minLength":1,"maxLength":255},"accountEmail":{"anyOf":[{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"accountTel":{"anyOf":[{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},{"type":"null"}]},"location":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"itemName":{"type":"string","minLength":1,"maxLength":255},"sku":{"type":"string","minLength":1,"maxLength":255},"orderedQuantity":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"movedQuantity":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"remainingQuantity":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"unitLabel":{"type":"string","minLength":1,"maxLength":255},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"state":{"type":"string","enum":["awaitingDate","scheduled","fulfilled"]},"stateLabel":{"type":"string","minLength":1,"maxLength":255},"timing":{"type":"string","enum":["pastDue","thisWeek","later","needsWindow","fulfilled"]},"movement":{"type":"string","enum":["awaitingDate","ready","complete"]},"movementLabel":{"type":"string","minLength":1,"maxLength":255},"invoiceState":{"type":"string","enum":["waitingOnFulfillment","readyToInvoice"]},"sourceOptions":{"type":"array","items":{"type":"object","properties":{"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1,"maxLength":255},"available":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"unitLabel":{"type":"string","minLength":1,"maxLength":255}},"required":["warehouseId","label","available","unit","unitLabel"],"additionalProperties":false}},"stock":{"anyOf":[{"type":"object","properties":{"onHand":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"shortfall":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"readiness":{"type":"string","enum":["ready","short","none"]},"label":{"type":"string","minLength":1,"maxLength":255}},"required":["onHand","shortfall","readiness","label"],"additionalProperties":false},{"type":"null"}]},"mixedFrom":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"blendRecipe":{"anyOf":[{"type":"object","properties":{"components":{"type":"array","items":{"type":"object","properties":{"ingredientItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"saleUnit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"part":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"form":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dry"},"analysis":{"type":"object","properties":{"n":{"type":"number","minimum":0,"maximum":100},"p2o5":{"type":"number","minimum":0,"maximum":100},"k2o":{"type":"number","minimum":0,"maximum":100},"s":{"type":"number","minimum":0,"maximum":100}},"required":["n","p2o5","k2o","s"],"additionalProperties":false}},"required":["kind","analysis"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"liquid"},"analysis":{"type":"object","properties":{"n":{"type":"number","minimum":0,"maximum":100},"p2o5":{"type":"number","minimum":0,"maximum":100},"k2o":{"type":"number","minimum":0,"maximum":100},"s":{"type":"number","minimum":0,"maximum":100}},"required":["n","p2o5","k2o","s"],"additionalProperties":false},"lbPerGal":{"type":"number","minimum":5,"maximum":15}},"required":["kind","analysis","lbPerGal"],"additionalProperties":false}]}},"required":["ingredientItemId","saleUnit","part","form"],"additionalProperties":false}},"names":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}}},"required":["components","names"],"additionalProperties":false},{"type":"null"}]}},"required":["arm","id","accountId","dealId","saleOrderId","lineId","catalogItemId","mode","modes","group","orderLabel","orderNumber","accountName","contactName","farmName","accountEmail","accountTel","location","itemName","sku","orderedQuantity","movedQuantity","remainingQuantity","unit","unitLabel","timeWindow","note","state","stateLabel","timing","movement","movementLabel","invoiceState","sourceOptions","stock","mixedFrom","blendRecipe"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"mode":{"type":"string","enum":["delivery","pickup"]},"modes":{"type":"array","items":{"type":"string","enum":["delivery","pickup"]},"minItems":1},"group":{"oneOf":[{"type":"object","properties":{"mode":{"type":"string","const":"pickup"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1,"maxLength":255}},"required":["mode","warehouseId","label"],"additionalProperties":false},{"type":"object","properties":{"mode":{"type":"string","const":"delivery"},"destinationFieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1}},"required":["mode","destinationFieldId","label"],"additionalProperties":false}]},"orderLabel":{"type":"string","minLength":1,"maxLength":255},"orderNumber":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"accountName":{"type":"string","minLength":1,"maxLength":255},"contactName":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"farmName":{"type":"string","minLength":1,"maxLength":255},"accountEmail":{"anyOf":[{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"accountTel":{"anyOf":[{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},{"type":"null"}]},"location":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"itemName":{"type":"string","minLength":1,"maxLength":255},"sku":{"type":"string","minLength":1,"maxLength":255},"orderedQuantity":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"movedQuantity":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"remainingQuantity":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"unitLabel":{"type":"string","minLength":1,"maxLength":255},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"state":{"type":"string","enum":["awaitingDate","scheduled","fulfilled"]},"stateLabel":{"type":"string","minLength":1,"maxLength":255},"timing":{"type":"string","enum":["pastDue","thisWeek","later","needsWindow","fulfilled"]},"movement":{"type":"string","enum":["awaitingDate","ready","complete"]},"movementLabel":{"type":"string","minLength":1,"maxLength":255},"sourceOptions":{"type":"array","items":{"type":"object","properties":{"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1,"maxLength":255},"available":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"unitLabel":{"type":"string","minLength":1,"maxLength":255}},"required":["warehouseId","label","available","unit","unitLabel"],"additionalProperties":false}},"stock":{"anyOf":[{"type":"object","properties":{"onHand":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"shortfall":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"readiness":{"type":"string","enum":["ready","short","none"]},"label":{"type":"string","minLength":1,"maxLength":255}},"required":["onHand","shortfall","readiness","label"],"additionalProperties":false},{"type":"null"}]},"mixedFrom":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"blendRecipe":{"anyOf":[{"type":"object","properties":{"components":{"type":"array","items":{"type":"object","properties":{"ingredientItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"saleUnit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"part":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"form":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dry"},"analysis":{"type":"object","properties":{"n":{"type":"number","minimum":0,"maximum":100},"p2o5":{"type":"number","minimum":0,"maximum":100},"k2o":{"type":"number","minimum":0,"maximum":100},"s":{"type":"number","minimum":0,"maximum":100}},"required":["n","p2o5","k2o","s"],"additionalProperties":false}},"required":["kind","analysis"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"liquid"},"analysis":{"type":"object","properties":{"n":{"type":"number","minimum":0,"maximum":100},"p2o5":{"type":"number","minimum":0,"maximum":100},"k2o":{"type":"number","minimum":0,"maximum":100},"s":{"type":"number","minimum":0,"maximum":100}},"required":["n","p2o5","k2o","s"],"additionalProperties":false},"lbPerGal":{"type":"number","minimum":5,"maximum":15}},"required":["kind","analysis","lbPerGal"],"additionalProperties":false}]}},"required":["ingredientItemId","saleUnit","part","form"],"additionalProperties":false}},"names":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}}},"required":["components","names"],"additionalProperties":false},{"type":"null"}]},"arm":{"type":"string","const":"supplier"},"today":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["id","saleOrderId","lineId","catalogItemId","mode","modes","group","orderLabel","orderNumber","accountName","contactName","farmName","accountEmail","accountTel","location","itemName","sku","orderedQuantity","movedQuantity","remainingQuantity","unit","unitLabel","timeWindow","note","state","stateLabel","timing","movement","movementLabel","sourceOptions","stock","mixedFrom","blendRecipe","arm","today"],"additionalProperties":false}]}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"facets":{"type":"object","properties":{"open":{"type":"integer","minimum":0,"maximum":9007199254740991},"all":{"type":"integer","minimum":0,"maximum":9007199254740991},"pastDue":{"type":"integer","minimum":0,"maximum":9007199254740991},"needsWindow":{"type":"integer","minimum":0,"maximum":9007199254740991},"thisWeek":{"type":"integer","minimum":0,"maximum":9007199254740991},"later":{"type":"integer","minimum":0,"maximum":9007199254740991},"partial":{"type":"integer","minimum":0,"maximum":9007199254740991},"fulfilled":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["open","all","pastDue","needsWindow","thisWeek","later","partial","fulfilled"],"additionalProperties":false}},"required":["rows","total","nextCursor","facets"],"additionalProperties":false}
lineFulfillment.revisePlanBusiness procedure UI supported

Input shape documented

object | object | object

2 schema notes
  • $|1.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|2.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"anyOf":[{"type":"object","properties":{"lineFulfillmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"plan":{"oneOf":[{"type":"object","properties":{"mode":{"type":"string","const":"delivery"},"destinationFieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["mode","destinationFieldId"]},{"type":"object","properties":{"mode":{"type":"string","const":"pickup"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["mode","warehouseId"]}]}},"required":["lineFulfillmentId","plan"],"additionalProperties":false},{"type":"object","properties":{"lineFulfillmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]}},"required":["lineFulfillmentId","timeWindow","note"],"additionalProperties":false},{"type":"object","properties":{"lineFulfillmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"plan":{"oneOf":[{"type":"object","properties":{"mode":{"type":"string","const":"delivery"},"destinationFieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["mode","destinationFieldId"]},{"type":"object","properties":{"mode":{"type":"string","const":"pickup"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["mode","warehouseId"]}]},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]}},"required":["lineFulfillmentId","plan","timeWindow","note"],"additionalProperties":false}]}

Output shape documented

object | object

8 schema notes
  • $|0.value|0.qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|0.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|1.qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|1.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|2.qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|2.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|3.qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|3.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"open"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"parentLineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"plan":{"oneOf":[{"type":"object","properties":{"mode":{"type":"string","const":"delivery"},"destinationFieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"destination":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false}},"required":["mode","destinationFieldId","destination"],"additionalProperties":false},{"type":"object","properties":{"mode":{"type":"string","const":"pickup"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["mode","warehouseId"],"additionalProperties":false}]},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"}},"required":["_tag","id","companyId","saleOrderId","lineId","catalogItemId","parentLineFulfillmentId","qty","plan","timeWindow","note","createdAt"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"fulfilled"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"parentLineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"plan":{"oneOf":[{"type":"object","properties":{"mode":{"type":"string","const":"delivery"},"destinationFieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"destination":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false}},"required":["mode","destinationFieldId","destination"],"additionalProperties":false},{"type":"object","properties":{"mode":{"type":"string","const":"pickup"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["mode","warehouseId"],"additionalProperties":false},{"type":"object","properties":{"mode":{"type":"string","const":"notRecorded"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["mode","warehouseId"],"additionalProperties":false}]},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"fulfilledAt":{"type":"string","format":"date-time","x-zod-type":"date"}},"required":["_tag","id","companyId","saleOrderId","lineId","catalogItemId","parentLineFulfillmentId","qty","plan","timeWindow","note","createdAt","fulfilledAt"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"cancelled"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"parentLineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"plan":{"oneOf":[{"type":"object","properties":{"mode":{"type":"string","const":"delivery"},"destinationFieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"destination":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false}},"required":["mode","destinationFieldId","destination"],"additionalProperties":false},{"type":"object","properties":{"mode":{"type":"string","const":"pickup"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["mode","warehouseId"],"additionalProperties":false}]},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"cancelledAt":{"type":"string","format":"date-time","x-zod-type":"date"},"reason":{"type":"string","minLength":1,"maxLength":5000}},"required":["_tag","id","companyId","saleOrderId","lineId","catalogItemId","parentLineFulfillmentId","qty","plan","timeWindow","note","createdAt","cancelledAt","reason"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"superseded"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"parentLineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"plan":{"oneOf":[{"type":"object","properties":{"mode":{"type":"string","const":"delivery"},"destinationFieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"destination":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false}},"required":["mode","destinationFieldId","destination"],"additionalProperties":false},{"type":"object","properties":{"mode":{"type":"string","const":"pickup"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["mode","warehouseId"],"additionalProperties":false}]},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","x-zod-type":"date"},"supersededAt":{"type":"string","format":"date-time","x-zod-type":"date"}},"required":["_tag","id","companyId","saleOrderId","lineId","catalogItemId","parentLineFulfillmentId","qty","plan","timeWindow","note","createdAt","supersededAt"],"additionalProperties":false}]}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_open"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_destination"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unknown_warehouse"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"supplier_endpoint_fixed"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}

note

Account notes

Account note and pinned-note query, follow-up, and update fields.

note.addBusiness procedure UI supported

Input contains unmodeled nodes

FieldLogical typePresence
accountIdstring (uuid)required
kind"note" | "call" | "email" | "visit" | "follow_up"required
bodyobjectrequired
dueAtstring (date-time)may be omitted
contextobjectmay be omitted
3 schema notes
  • $.body refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.body.content[] unsupported: This schema node is unmodeled. Displayed component or inner shapes are informational; no accepted value shape is inferred for the missing representation.
  • $.dueAt runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["note","call","email","visit","follow_up"]},"body":{"type":"object","properties":{"type":{"type":"string","const":"doc"},"content":{"type":"array","items":{"x-unsupported":"lazy"}}},"required":["type","content"]},"dueAt":{"type":"string","format":"date-time","x-zod-type":"date"},"context":{"type":"object","properties":{"kind":{"type":"string","const":"deal"},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","dealId"]}},"required":["accountId","kind","body"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"interactionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["interactionId","accountId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false}},"required":["ok","error"],"additionalProperties":false}]}
note.bookTodayBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["accountId"]}

Output shape documented

FieldLogical typePresence
todayCalendarDayrequired
Full logical schema
{"type":"object","properties":{"today":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["today"],"additionalProperties":false}
note.byAccountBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["accountId"]}

Output contains unmodeled nodes

array of object

2 schema notes
  • $[].body.content[] unsupported: This schema node is unmodeled. Displayed component or inner shapes are informational; no accepted value shape is inferred for the missing representation.
  • $[].bodyText runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"authorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["note","call","email","visit","follow_up"]},"kindLabel":{"type":"string","minLength":1,"maxLength":255},"body":{"type":"object","properties":{"type":{"type":"string","const":"doc"},"content":{"type":"array","items":{"x-unsupported":"lazy"}}},"required":["type","content"],"additionalProperties":false},"bodyText":{"type":"string","maxLength":5000},"dueAt":{"type":"string","format":"date-time","x-zod-type":"date"},"dueDay":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"}},"required":["id","accountId","authorId","kind","kindLabel","body","bodyText","at"],"additionalProperties":false}}
note.byContextBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
kind"deal"required
dealIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"kind":{"type":"string","const":"deal"},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","dealId"]}

Output contains unmodeled nodes

array of object

2 schema notes
  • $[].body.content[] unsupported: This schema node is unmodeled. Displayed component or inner shapes are informational; no accepted value shape is inferred for the missing representation.
  • $[].bodyText runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"authorId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"kind":{"type":"string","enum":["note","call","email","visit","follow_up"]},"kindLabel":{"type":"string","minLength":1,"maxLength":255},"body":{"type":"object","properties":{"type":{"type":"string","const":"doc"},"content":{"type":"array","items":{"x-unsupported":"lazy"}}},"required":["type","content"],"additionalProperties":false},"bodyText":{"type":"string","maxLength":5000},"dueAt":{"type":"string","format":"date-time","x-zod-type":"date"},"dueDay":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"}},"required":["id","accountId","authorId","kind","kindLabel","body","bodyText","at"],"additionalProperties":false}}
note.pinBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
interactionIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"interactionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["interactionId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"pinnedNoteId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"interactionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["pinnedNoteId","interactionId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"already_pinned"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}

orderPlan

Order planning

Saved order-line plan fields and confirmation results.

orderPlan.confirmBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
saleOrderIdstring (uuid)required
linesarray of object | objectrequired
3 schema notes
  • $.lines refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[]|0.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[]|1.timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lines":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"mode":{"type":"string","const":"delivery"},"destinationFieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]}},"required":["lineId","mode","destinationFieldId","timeWindow"]},{"type":"object","properties":{"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"mode":{"type":"string","const":"pickup"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]}},"required":["lineId","mode","warehouseId","timeWindow"]}]},"minItems":1}},"required":["saleOrderId","lines"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"linesConfirmed":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["saleOrderId","linesConfirmed"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member","not_open","already_confirmed","line_set_mismatch","unknown_warehouse","no_destination","supplier_ambiguous","supplier_item_mismatch","supplier_item_ambiguous","supplier_pickup_unsupported"]}},"required":["code"],"additionalProperties":false}},"required":["ok","error"],"additionalProperties":false}]}
orderPlan.linesPlanBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
saleOrderIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["saleOrderId"]}

Output shape documented

FieldLogical typePresence
dealTitlestringrequired
ownerAccountIdstringrequired
summaryobjectrequired
editableFulfillmentsarray of objectrequired
locationsarray of objectrequired
rowsarray of objectrequired
confirmation"available" | "blocked" | "complete"required
awaitingCountintegerrequired
invoice"not_ready" | "ready" | "invoiced"required
orderStatus"pendingFulfillment" | "awaitingConfirmation" | "fulfilled" | "partiallyFulfilled"required
nextStep"confirmOrder" | "scheduleFulfillment" | "fulfill" | "awaitSupplier" | "invoice"required
todayCalendarDayrequired
workHeldarray of "read" | "revisePlan" | "fulfill"required
awaitingSupplierLabelstring | nullrequired
endpointsarray of "delivery" | "pickup"required
6 schema notes
  • $.editableFulfillments[].timeWindow|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.editableFulfillments[].openQuantity refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].qty.ordered refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].cancelItem runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].returnState runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].shipmentSummary runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"dealTitle":{"type":"string","minLength":1,"maxLength":255},"ownerAccountId":{"type":"string","minLength":1,"maxLength":255},"summary":{"type":"object","properties":{"progress":{"type":"object","properties":{"itemsFulfilled":{"type":"integer","minimum":0,"maximum":9007199254740991},"itemsTotal":{"type":"integer","minimum":0,"maximum":9007199254740991},"state":{"type":"string","enum":["open","complete"]}},"required":["itemsFulfilled","itemsTotal","state"],"additionalProperties":false},"progressLabel":{"type":"string","minLength":1,"maxLength":255},"itemsLabel":{"type":"string","minLength":1,"maxLength":255},"confirmationLabel":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]}},"required":["progress","progressLabel","itemsLabel","confirmationLabel"],"additionalProperties":false},"editableFulfillments":{"type":"array","items":{"type":"object","properties":{"rowId":{"type":"string","minLength":1,"maxLength":255},"lineFulfillmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"note":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"timeWindow":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},"openQuantity":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"endpoints":{"type":"array","items":{"type":"string","enum":["delivery","pickup"]}}},"required":["rowId","lineFulfillmentId","note","timeWindow","openQuantity","endpoints"],"additionalProperties":false}},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":255},"mode":{"type":"string","enum":["delivery","pickup"]},"name":{"type":"string","minLength":1},"place":{"type":"string","minLength":1}},"required":["id","mode","name","place"],"additionalProperties":false}},"rows":{"type":"array","items":{"type":"object","properties":{"rowId":{"type":"string","minLength":1,"maxLength":255},"supplier":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"item":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"pack":{"type":"string","minLength":1,"maxLength":255},"sku":{"type":"string","minLength":1,"maxLength":255},"category":{"type":"string","minLength":1,"maxLength":255}},"required":["name","pack","sku","category"],"additionalProperties":false},"qty":{"type":"object","properties":{"ordered":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"moved":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["ordered","moved","unit"],"additionalProperties":false},"unitPrice":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"unitPricePerUnit":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"lineTotal":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"mode":{"type":"string","enum":["delivery","pickup","notRecorded"]},"modes":{"type":"array","items":{"type":"string","enum":["delivery","pickup","notRecorded"]},"minItems":1},"targetMonth":{"anyOf":[{"type":"string","minLength":1,"maxLength":255,"pattern":"^(\\d{4}-\\d{2}|asap)$"},{"type":"null"}]},"location":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":255},"mode":{"type":"string","enum":["delivery","pickup"]},"name":{"type":"string","minLength":1},"place":{"type":"string","minLength":1}},"required":["id","mode","name","place"],"additionalProperties":false},{"type":"null"}]},"status":{"anyOf":[{"type":"string","enum":["cancelled","fulfilled","inProgress","scheduled","awaitingDate"]},{"type":"null"}]},"endpoints":{"type":"array","items":{"type":"string","enum":["delivery","pickup"]},"minItems":1},"cancelItem":{"anyOf":[{"type":"object","properties":{"loanRef":{"type":"string","minLength":1,"maxLength":128},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"cancelsDelivery":{"type":"boolean"}},"required":["loanRef","amount","cancelsDelivery"],"additionalProperties":false},{"type":"null"}]},"returnState":{"type":"string","enum":["none","inFlight","returned"]},"shipmentSummary":{"type":"object","properties":{"inTransit":{"type":"boolean"},"lastDeliveredDay":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]}},"required":["inTransit","lastDeliveredDay"],"additionalProperties":false}},"required":["rowId","supplier","item","qty","unitPrice","unitPricePerUnit","lineTotal","mode","modes","targetMonth","location","status","endpoints","cancelItem","returnState","shipmentSummary"],"additionalProperties":false}},"confirmation":{"type":"string","enum":["available","blocked","complete"]},"awaitingCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"invoice":{"type":"string","enum":["not_ready","ready","invoiced"]},"orderStatus":{"type":"string","enum":["pendingFulfillment","awaitingConfirmation","fulfilled","partiallyFulfilled"]},"nextStep":{"type":"string","enum":["confirmOrder","scheduleFulfillment","fulfill","awaitSupplier","invoice"]},"today":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"workHeld":{"type":"array","items":{"type":"string","enum":["read","revisePlan","fulfill"]}},"awaitingSupplierLabel":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"endpoints":{"type":"array","items":{"type":"string","enum":["delivery","pickup"]},"minItems":1}},"required":["dealTitle","ownerAccountId","summary","editableFulfillments","locations","rows","confirmation","awaitingCount","invoice","orderStatus","nextStep","today","workHeld","awaitingSupplierLabel","endpoints"],"additionalProperties":false}

orders

Order counts

Filter fields and integer result shape for order counts.

orders.countCount orders matching a filter. UI supported

Input shape documented

FieldLogical typePresence
matchobject | objectmay be omitted
sort"recentlyConfirmed" | "oldestFirst" | "soonestFirst" | "latestFirst"may be omitted
accountIdstring (uuid)may be omitted
tab"active" | "all" | "unconfirmed"may be omitted
limitintegermay be omitted
cursorstring | nullmay be omitted
7 schema notes
  • $.match|1.q refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.match runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sort runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tab runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"match":{"oneOf":[{"type":"object","properties":{"by":{"type":"string","const":"none"}},"required":["by"]},{"type":"object","properties":{"by":{"type":"string","const":"text"},"q":{"type":"string","minLength":1}},"required":["by","q"]}]},"sort":{"type":"string","enum":["recentlyConfirmed","oldestFirst","soonestFirst","latestFirst"]},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"tab":{"type":"string","enum":["active","all","unconfirmed"]},"limit":{"type":"integer","minimum":1,"maximum":200},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}}}

Output shape documented

integer

Full logical schema
{"type":"integer","minimum":0,"maximum":9007199254740991}
orders.searchWithFacetsBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
matchobject | objectmay be omitted
accountIdstring (uuid)may be omitted
tab"active" | "all" | "unconfirmed"may be omitted
sort"recentlyConfirmed" | "oldestFirst" | "soonestFirst" | "latestFirst"may be omitted
limitintegermay be omitted
cursorstring | nullmay be omitted
7 schema notes
  • $.match|1.q refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.match runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.tab runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sort runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"match":{"oneOf":[{"type":"object","properties":{"by":{"type":"string","const":"none"}},"required":["by"]},{"type":"object","properties":{"by":{"type":"string","const":"text"},"q":{"type":"string","minLength":1}},"required":["by","q"]}]},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"tab":{"type":"string","enum":["active","all","unconfirmed"]},"sort":{"type":"string","enum":["recentlyConfirmed","oldestFirst","soonestFirst","latestFirst"]},"limit":{"type":"integer","minimum":1,"maximum":200},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
totalintegerrequired
nextCursorstring | nullrequired
facetsobjectrequired
totalsobjectrequired
2 schema notes
  • $.rows[].accountEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].deliveryDate|0 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountName":{"type":"string","minLength":1,"maxLength":255},"farmName":{"type":"string","minLength":1,"maxLength":255},"contactName":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"accountEmail":{"anyOf":[{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"accountTel":{"anyOf":[{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},{"type":"null"}]},"location":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"orderDate":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"orderNumber":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"orderTotal":{"anyOf":[{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},{"type":"null"}]},"deliveryDate":{"anyOf":[{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dated"},"startOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"endOn":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["kind","startOn","endOn"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"asap"}},"required":["kind"],"additionalProperties":false}]},{"type":"null"}]},"orderStatus":{"type":"string","enum":["pendingFulfillment","awaitingConfirmation","fulfilled","partiallyFulfilled"]},"linesNotScheduled":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"linesScheduled":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"linesFulfilled":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"linesTotal":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"progress":{"anyOf":[{"type":"object","properties":{"itemsFulfilled":{"type":"integer","minimum":0,"maximum":9007199254740991},"itemsTotal":{"type":"integer","minimum":0,"maximum":9007199254740991},"state":{"type":"string","enum":["open","complete"]}},"required":["itemsFulfilled","itemsTotal","state"],"additionalProperties":false},{"type":"null"}]},"nextStep":{"type":"string","enum":["confirmOrder","scheduleFulfillment","fulfill","awaitSupplier","invoice"]},"workHeld":{"type":"array","items":{"type":"string","enum":["read","revisePlan","fulfill"]}}},"required":["accountId","dealId","saleOrderId","accountName","farmName","contactName","accountEmail","accountTel","location","orderDate","orderNumber","orderTotal","deliveryDate","orderStatus","linesNotScheduled","linesScheduled","linesFulfilled","linesTotal","progress","nextStep","workHeld"],"additionalProperties":false}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"facets":{"type":"object","properties":{"active":{"type":"integer","minimum":0,"maximum":9007199254740991},"all":{"type":"integer","minimum":0,"maximum":9007199254740991},"unconfirmed":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["active","all","unconfirmed"],"additionalProperties":false},"totals":{"type":"object","properties":{"orders":{"type":"integer","minimum":0,"maximum":9007199254740991},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"notScheduled":{"type":"integer","minimum":0,"maximum":9007199254740991},"scheduled":{"type":"integer","minimum":0,"maximum":9007199254740991},"fulfilled":{"type":"integer","minimum":0,"maximum":9007199254740991},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"ordersLabel":{"type":"string","minLength":1,"maxLength":255},"fulfilledLabel":{"type":"string","minLength":1,"maxLength":255}},"required":["orders","amount","notScheduled","scheduled","fulfilled","total","ordersLabel","fulfilledLabel"],"additionalProperties":false}},"required":["rows","total","nextCursor","facets","totals"],"additionalProperties":false}

organization

Organization records

Organization information linked to an account, including lookup, creation, and revision fields.

organization.createBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
namestringrequired
entityType"llc" | "general_partnership" | "limited_partnership" | "corporation" | "joint_venture" | "trust"required
feinstring (fein)may be omitted
incorporatedDateCalendarDaymay be omitted
incorporatedLocation"AL" | "AK" | "AZ" | "AR" | "CA" | "CO" | "CT" | "DE" | "DC" | "FL" | "GA" | "HI" | "ID" | "IL" | "IN" | "IA" | "KS" | "KY" | "LA" | "ME" | "MD" | "MA" | "MI" | "MN" | "MS" | "MO" | "MT" | "NE" | "NV" | "NH" | "NJ" | "NM" | "NY" | "NC" | "ND" | "OH" | "OK" | "OR" | "PA" | "RI" | "SC" | "SD" | "TN" | "TX" | "UT" | "VT" | "VA" | "WA" | "WV" | "WI" | "WY"may be omitted
businessAddressobjectmay be omitted
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"entityType":{"type":"string","enum":["llc","general_partnership","limited_partnership","corporation","joint_venture","trust"],"format":"enum"},"fein":{"type":"string","pattern":"^\\d{9}$","format":"fein"},"incorporatedDate":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"incorporatedLocation":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"businessAddress":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"]}},"required":["accountId","name","entityType"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"organizationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["organizationId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"organization_exists"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
organization.forAccountBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["accountId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"empty"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"held"},"entity":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"entityType":{"type":"string","enum":["llc","general_partnership","limited_partnership","corporation","joint_venture","trust"],"format":"enum"},"fein":{"type":"string","pattern":"^\\d{9}$","format":"fein"},"incorporatedDate":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"incorporatedLocation":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"businessAddressId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"_tag":{"type":"string","enum":["unverified","verified"]},"held":{"type":"array","items":{"type":"string","enum":["verify","revise"]}},"businessAddress":{"anyOf":[{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false},{"type":"null"}]}},"required":["id","accountId","name","entityType","_tag","held","businessAddress"],"additionalProperties":false}},"required":["_tag","entity"],"additionalProperties":false}]}
organization.reviseBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
organizationIdstring (uuid)required
namestringmay be omitted
entityType"llc" | "general_partnership" | "limited_partnership" | "corporation" | "joint_venture" | "trust"may be omitted
feinstring (fein) | nullmay be omitted
incorporatedDateCalendarDay | nullmay be omitted
incorporatedLocation"AL" | "AK" | "AZ" | "AR" | "CA" | "CO" | "CT" | "DE" | "DC" | "FL" | "GA" | "HI" | "ID" | "IL" | "IN" | "IA" | "KS" | "KY" | "LA" | "ME" | "MD" | "MA" | "MI" | "MN" | "MS" | "MO" | "MT" | "NE" | "NV" | "NH" | "NJ" | "NM" | "NY" | "NC" | "ND" | "OH" | "OK" | "OR" | "PA" | "RI" | "SC" | "SD" | "TN" | "TX" | "UT" | "VT" | "VA" | "WA" | "WV" | "WI" | "WY" | nullmay be omitted
businessAddressobject | nullmay be omitted
Full logical schema
{"type":"object","properties":{"organizationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"entityType":{"type":"string","enum":["llc","general_partnership","limited_partnership","corporation","joint_venture","trust"],"format":"enum"},"fein":{"anyOf":[{"type":"string","pattern":"^\\d{9}$","format":"fein"},{"type":"null"}]},"incorporatedDate":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"incorporatedLocation":{"anyOf":[{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},{"type":"null"}]},"businessAddress":{"anyOf":[{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"]},{"type":"null"}]}},"required":["organizationId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"organizationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["organizationId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"organization_not_editable"}},"required":["code"],"additionalProperties":false}]},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"fein_on_file"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"incorporated_date_on_file"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"incorporated_location_on_file"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"business_address_on_file"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}

person

People and contacts

Person lookup and contact-detail revision fields used with business accounts.

person.byAccountBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
accountIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["accountId"]}

Output shape documented

array of object

3 schema notes
  • $[].person.firstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $[].person.lastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $[].person.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["primary","additional"]},"person":{"type":"object","properties":{"_tag":{"type":"string","enum":["unverified","verified"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"billingAddressId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"billingAddress":{"anyOf":[{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"address"},"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"type":"string","minLength":1,"maxLength":255},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","street","city","state","zip","id"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"not_resolvable"}},"required":["_tag"],"additionalProperties":false}]},{"type":"null"}]}},"required":["_tag","id","ownerId","firstName","lastName","billingAddress"],"additionalProperties":false}},"required":["role","person"],"additionalProperties":false}}
person.byIdBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
idstring (uuid)required
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"]}

Output shape documented

FieldLogical typePresence
_tag"unverified" | "verified"required
idstring (uuid)required
ownerIdstring (uuid)required
firstNamestringrequired
lastNamestringrequired
emailstring (email)may be omitted
phonestring (phone)may be omitted
billingAddressIdstring (uuid)may be omitted
billingAddressobject | object | nullrequired
heldarray of "read" | "create" | "reassign" | "confirmEmail" | "reviseContact" | "reviseVerifiedContact" | "verify" | "restamp" | "refreshVerifiedIdentity"required
3 schema notes
  • $.firstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"_tag":{"type":"string","enum":["unverified","verified"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"billingAddressId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"billingAddress":{"anyOf":[{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"address"},"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"type":"string","minLength":1,"maxLength":255},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","street","city","state","zip","id"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"not_resolvable"}},"required":["_tag"],"additionalProperties":false}]},{"type":"null"}]},"held":{"type":"array","items":{"type":"string","enum":["read","create","reassign","confirmEmail","reviseContact","reviseVerifiedContact","verify","restamp","refreshVerifiedIdentity"]}}},"required":["_tag","id","ownerId","firstName","lastName","billingAddress","held"],"additionalProperties":false}
person.listBusiness procedure UI supported

Input

No input schema declared; no input shape inferred.

Output shape documented

array of object

3 schema notes
  • $[].firstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $[].lastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $[].email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"array","items":{"type":"object","properties":{"_tag":{"type":"string","enum":["unverified","verified"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"billingAddressId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","id","ownerId","firstName","lastName"],"additionalProperties":false}}
person.reviseContactBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
personIdstring (uuid)required
firstNamestringmay be omitted
lastNamestringmay be omitted
emailstring (email)may be omitted
phonestring (phone)may be omitted
billingAddressobjectmay be omitted
3 schema notes
  • $.firstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"personId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"billingAddress":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"]}},"required":["personId"]}

Output shape documented

object | object

3 schema notes
  • $|0.value.firstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.lastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"_tag":{"type":"string","enum":["unverified","verified"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"billingAddressId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","id","ownerId","firstName","lastName"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"email_in_use"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"phone_in_use"}},"required":["code"],"additionalProperties":false}]},{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"contact_not_editable"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
person.reviseVerifiedContactBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
personIdstring (uuid)required
phonestring (phone)may be omitted
billingAddressobjectmay be omitted
Full logical schema
{"type":"object","properties":{"personId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"billingAddress":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"]}},"required":["personId"],"additionalProperties":false}

Output shape documented

object | object

3 schema notes
  • $|0.value.firstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.lastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"_tag":{"type":"string","enum":["unverified","verified"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"billingAddressId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","id","ownerId","firstName","lastName"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"email_in_use"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"phone_in_use"}},"required":["code"],"additionalProperties":false}]},{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"contact_not_editable"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}

po

Purchase-order records and actions

Purchase-order lists and details, receiving and warehouse choices, document and message previews, and order update results.

po.addWarehouseBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
namestringrequired
arrangement"owned" | "rented" | "thirdParty"required
pickup"enabled" | "shipFromOnly"required
addressobjectrequired
Full logical schema
{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"arrangement":{"type":"string","enum":["owned","rented","thirdParty"],"format":"enum"},"pickup":{"type":"string","enum":["enabled","shipFromOnly"],"format":"enum"},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"]}},"required":["name","arrangement","pickup","address"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"locationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["locationId","warehouseId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
po.attachDocumentsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
purchaseOrderIdstring (uuid)required
documentIdsarray of string (uuid)required
Full logical schema
{"type":"object","properties":{"purchaseOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"documentIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"minItems":1}},"required":["purchaseOrderId","documentIds"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"purchaseOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"documentIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["purchaseOrderId","documentIds"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false}},"required":["ok","error"],"additionalProperties":false}]}
po.byIdBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
idstring (uuid)required
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"]}

Output shape documented

FieldLogical typePresence
idstring (uuid)required
refstringrequired
kind"open" | "partial" | "received" | "cancelled"required
labelstringrequired
orderedAtstring (date-time)required
supplierCompanyIdstring (uuid)required
destinationLocationIdstring (uuid)required
linesSettledinteger (number)required
linesTotalinteger (number)required
orderedinteger (money) | nullrequired
estLandedinteger (money) | nullrequired
openExposureinteger (money) | nullrequired
attachmentsarray of objectrequired
verdictsobjectrequired
poNumberintegerrequired
receivedCostinteger (money) | nullrequired
rollupsarray of objectrequired
estFreightBpsintegermay be omitted
expectedAtCalendarDaymay be omitted
notesstringmay be omitted
receivingNotesarray of objectrequired
sourceSaleOrderIdstring (uuid)may be omitted
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ref":{"type":"string"},"kind":{"type":"string","enum":["open","partial","received","cancelled"]},"label":{"type":"string"},"orderedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"supplierCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"destinationLocationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"linesSettled":{"type":"integer","minimum":0,"maximum":9007199254740991,"format":"number"},"linesTotal":{"type":"integer","minimum":0,"maximum":9007199254740991,"format":"number"},"ordered":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"estLanded":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"openExposure":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"attachments":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"bytes":{"type":"integer","exclusiveMinimum":0,"maximum":52428800},"addedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"addedBy":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"addedByName":{"type":"string","minLength":1,"maxLength":255},"downloadUrl":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]}},"required":["documentId","name","bytes","addedAt","addedBy","addedByName","downloadUrl"],"additionalProperties":false}},"verdicts":{"type":"object","properties":{"cancel":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["has_receipts","po_cancelled"]}},"required":["status","error"],"additionalProperties":false}]},"receive":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["has_receipts","po_cancelled"]}},"required":["status","error"],"additionalProperties":false}]},"send":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["has_receipts","po_cancelled"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["cancel","receive","send"],"additionalProperties":false},"poNumber":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"receivedCost":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"rollups":{"type":"array","items":{"type":"object","properties":{"lineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineNo":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sku":{"type":"string","minLength":1,"maxLength":64},"ordered":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"received":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"forgiven":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"outstanding":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"unitCost":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]}},"required":["lineId","lineNo","catalogItemId","sku","ordered","received","forgiven","outstanding","unitCost"],"additionalProperties":false}},"estFreightBps":{"type":"integer","minimum":0,"maximum":10000},"expectedAt":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"notes":{"type":"string"},"receivingNotes":{"type":"array","items":{"type":"object","properties":{"receivedAt":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"note":{"type":"string","minLength":1,"maxLength":5000}},"required":["receivedAt","note"],"additionalProperties":false}},"sourceSaleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id","ref","kind","label","orderedAt","supplierCompanyId","destinationLocationId","linesSettled","linesTotal","ordered","estLanded","openExposure","attachments","verdicts","poNumber","receivedCost","rollups","receivingNotes"],"additionalProperties":false}
po.cancelBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
purchaseOrderIdstring (uuid)required
reasonstringrequired
Full logical schema
{"type":"object","properties":{"purchaseOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reason":{"type":"string","minLength":1,"maxLength":5000}},"required":["purchaseOrderId","reason"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"purchaseOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["purchaseOrderId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_open"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"has_receipts"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
po.closeShortBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
purchaseOrderIdstring (uuid)required
reasonstringrequired
Full logical schema
{"type":"object","properties":{"purchaseOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reason":{"type":"string","minLength":1,"maxLength":5000}},"required":["purchaseOrderId","reason"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"forgivenLines":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"qtyForgiven":{"type":"string","format":"decimal","x-wire-kind":"Amount"}},"required":["forgivenLines","qtyForgiven"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_open"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"nothing_outstanding"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
po.documentPdfBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
idstring (uuid)required
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"]}

Output shape documented

FieldLogical typePresence
filenamestringrequired
base64stringrequired
Full logical schema
{"type":"object","properties":{"filename":{"type":"string"},"base64":{"type":"string"}},"required":["filename","base64"],"additionalProperties":false}
po.listRead purchase orders. UI supported

Input shape documented

FieldLogical typePresence
supplierobject | objectmay be omitted
limitintegermay be omitted
cursorstring | nullmay be omitted
qstringmay be omitted
status"all" | "open" | "partial" | "received" | "cancelled"may be omitted
sort"newest"may be omitted
7 schema notes
  • $.supplier runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.q runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.status runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sort runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"supplier":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"any"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"only"},"supplierCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","supplierCompanyId"]}]},"limit":{"type":"integer","minimum":1,"maximum":200},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"q":{"type":"string","maxLength":120},"status":{"type":"string","enum":["all","open","partial","received","cancelled"]},"sort":{"type":"string","const":"newest"}}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
totalintegerrequired
nextCursorstring | nullrequired
facetsobjectrequired
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ref":{"type":"string"},"kind":{"type":"string","enum":["open","partial","received","cancelled"]},"label":{"type":"string"},"orderedAt":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"supplierCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"destinationLocationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"linesSettled":{"type":"integer","minimum":0,"maximum":9007199254740991,"format":"number"},"linesTotal":{"type":"integer","minimum":0,"maximum":9007199254740991,"format":"number"},"ordered":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"estLanded":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"openExposure":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"supplierName":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"warehouseName":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"termsLabel":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]}},"required":["id","ref","kind","label","orderedAt","supplierCompanyId","destinationLocationId","linesSettled","linesTotal","ordered","estLanded","openExposure","supplierName","warehouseName","termsLabel"],"additionalProperties":false}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"facets":{"type":"object","properties":{"all":{"type":"integer","minimum":0,"maximum":9007199254740991},"open":{"type":"integer","minimum":0,"maximum":9007199254740991},"partial":{"type":"integer","minimum":0,"maximum":9007199254740991},"received":{"type":"integer","minimum":0,"maximum":9007199254740991},"cancelled":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["all","open","partial","received","cancelled"],"additionalProperties":false}},"required":["rows","total","nextCursor","facets"],"additionalProperties":false}
po.receivableFind purchase orders available for receiving. Backend only

Input shape documented

FieldLogical typePresence
qstringrequired
Full logical schema
{"type":"object","properties":{"q":{"type":"string","maxLength":120}},"required":["q"]}

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ref":{"type":"string"},"supplierName":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"warehouseName":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"label":{"type":"string"}},"required":["id","ref","supplierName","warehouseName","label"],"additionalProperties":false}}
po.sendEmailBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
purchaseOrderIdstring (uuid)required
recipientsarray of objectrequired
1 schema note
  • $.recipients[].email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"purchaseOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"recipients":{"type":"array","items":{"type":"object","properties":{"personId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"required":["personId","email"]},"minItems":1}},"required":["purchaseOrderId","recipients"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"notificationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["notificationId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"po_cancelled"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"po_received"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_contact_email"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"recipient_not_on_account"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
po.sendPreviewBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
idstring (uuid)required
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"]}

Output shape documented

FieldLogical typePresence
referencestring | nullrequired
vendorNamestringrequired
linesinteger (number)required
subtotalinteger (money) | nullrequired
accountIdstring (uuid) | nullrequired
recipientsarray of objectrequired
reviseContactHeldarray of string (uuid)required
refusalobject | nullrequired
subjectstring | nullrequired
htmlstringrequired
attachmentstring | nullrequired
lastSendobject | nullrequired
2 schema notes
  • $.recipients[].email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lastSend.to[] refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"reference":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"vendorName":{"type":"string","minLength":1,"maxLength":255},"lines":{"type":"integer","minimum":0,"maximum":9007199254740991,"format":"number"},"subtotal":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"accountId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"recipients":{"type":"array","items":{"type":"object","properties":{"personId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"phone":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"addressLines":{"anyOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},{"type":"null"}]},"relationship":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"role":{"type":"string","enum":["primary","additional"]},"status":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]}},"required":["personId","name","phone","email","addressLines","relationship","role","status"],"additionalProperties":false}},"reviseContactHeld":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"refusal":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_contact_email"}},"required":["code"],"additionalProperties":false},{"type":"null"}]},"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"html":{"type":"string","minLength":1},"attachment":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"lastSend":{"anyOf":[{"type":"object","properties":{"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"to":{"type":"array","items":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"status":{"type":"string","minLength":1,"maxLength":255}},"required":["at","to","status"],"additionalProperties":false},{"type":"null"}]}},"required":["reference","vendorName","lines","subtotal","accountId","recipients","reviseContactHeld","refusal","subject","html","attachment","lastSend"],"additionalProperties":false}
po.warehousesBusiness procedure UI supported

Input

No input schema declared; no input shape inferred.

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}}

product

Product reference data

Shapes for product details such as additional data, blend ingredients, crop rates, costs, equivalents, regulatory information, market search, and supplier references.

product.additionalDataRead product ingredients and registration information. UI supported

Input shape documented

FieldLogical typePresence
productIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["productId"],"additionalProperties":false}

Output shape documented

object | object | object | object | null

Full logical schema
{"anyOf":[{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"not_fetched"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"none"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"details"},"ingredients":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"percent":{"anyOf":[{"type":"number","minimum":0,"maximum":100},{"type":"null"}]},"amount":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"modesOfAction":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}}},"required":["name","percent","amount","modesOfAction"],"additionalProperties":false}},"registrations":{"type":"array","items":{"type":"object","properties":{"registered":{"type":"string","enum":["Yes","No","Unknown"]},"states":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}}},"required":["registered","states"],"additionalProperties":false}}},"required":["kind","ingredients","registrations"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"}},"required":["kind"],"additionalProperties":false}]},{"type":"null"}]}
product.blendIngredientRead a product’s blend ingredient form and nutrient analysis. UI supported

Input shape documented

FieldLogical typePresence
productIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["productId"],"additionalProperties":false}

Output shape documented

FieldLogical typePresence
kind"dry" | "liquid" | nullrequired
rowsarray of objectrequired
11 schema notes
  • $.rows[].form|0.analysis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].form|0.analysis.n refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].form|0.analysis.p2o5 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].form|0.analysis.k2o refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].form|0.analysis.s refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].form|1.analysis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].form|1.analysis.n refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].form|1.analysis.p2o5 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].form|1.analysis.k2o refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].form|1.analysis.s refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].form|1.lbPerGal refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"kind":{"anyOf":[{"type":"string","enum":["dry","liquid"]},{"type":"null"}]},"rows":{"type":"array","items":{"type":"object","properties":{"form":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dry"},"analysis":{"type":"object","properties":{"n":{"type":"number","minimum":0,"maximum":100},"p2o5":{"type":"number","minimum":0,"maximum":100},"k2o":{"type":"number","minimum":0,"maximum":100},"s":{"type":"number","minimum":0,"maximum":100}},"required":["n","p2o5","k2o","s"],"additionalProperties":false}},"required":["kind","analysis"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"liquid"},"analysis":{"type":"object","properties":{"n":{"type":"number","minimum":0,"maximum":100},"p2o5":{"type":"number","minimum":0,"maximum":100},"k2o":{"type":"number","minimum":0,"maximum":100},"s":{"type":"number","minimum":0,"maximum":100}},"required":["n","p2o5","k2o","s"],"additionalProperties":false},"lbPerGal":{"type":"number","minimum":5,"maximum":15}},"required":["kind","analysis","lbPerGal"],"additionalProperties":false}]}},"required":["form"],"additionalProperties":false}}},"required":["kind","rows"],"additionalProperties":false}
product.byIdBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
idstring (uuid)required
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"]}

Output shape documented

FieldLogical typePresence
idstring (uuid)required
namestringrequired
compassIdstringmay be omitted
brandstringmay be omitted
manufacturerstringmay be omitted
epaRegistrationobject | objectmay be omitted
restrictedUsebooleanmay be omitted
makerstring | nullmay be omitted
categoriesarray of "herbicide" | "insecticide" | "fungicide" | "nematicide" | "miticide" | "fumigant" | "biopesticide" | "pgr" | "defoliant" | "desiccant" | "repellent" | "insect_growth_regulator" | "seed_treatment" | "seed_lubricant" | "seed" | "fertilizer" | "micronutrient" | "nutritional" | "manure" | "nitrogen_stabilizer" | "manure_treatment" | "biological" | "inoculant" | "biostimulant" | "adjuvant" | "tank_cleaner" | "equipment" | "service" | "other"required
heldarray of "create"required
itemHeldarray of "read" | "create" | "discontinue" | "setImage" | "setManufactured" | "supply" | "purchase"required
manufacturedBlockedarray of string (uuid)required
1 schema note
  • $.epaRegistration|0.number refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"compassId":{"type":"string","minLength":1},"brand":{"type":"string","minLength":1,"maxLength":255},"manufacturer":{"type":"string","minLength":1,"maxLength":255},"epaRegistration":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"registered"},"number":{"type":"string","minLength":1}},"required":["kind","number"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"exempt"}},"required":["kind"],"additionalProperties":false}]},"restrictedUse":{"type":"boolean"},"maker":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"categories":{"type":"array","items":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}},"held":{"type":"array","items":{"type":"string","const":"create"}},"itemHeld":{"type":"array","items":{"type":"string","enum":["read","create","discontinue","setImage","setManufactured","supply","purchase"]}},"manufacturedBlocked":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["id","name","categories","held","itemHeld","manufacturedBlocked"],"additionalProperties":false}
product.compassCropRatesRead provider crop application rates. UI supported

Input shape documented

FieldLogical typePresence
compassUidstringrequired
Full logical schema
{"type":"object","properties":{"compassUid":{"type":"string","minLength":1}},"required":["compassUid"],"additionalProperties":false}

Output shape documented

object | object

1 schema note
  • $|0.cropRates.rates[] refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"vendor":{"type":"string","const":"answered"},"cropRates":{"anyOf":[{"type":"object","properties":{"provenance":{"type":"string","const":"compass"},"rates":{"type":"array","items":{"type":"object","properties":{"crop":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"unspecified"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"system"},"crop":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]}},"required":["kind","crop"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"other"},"name":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","name"],"additionalProperties":false}]},"applicationMethod":{"type":"string","minLength":1,"maxLength":255},"min":{"type":"object","properties":{"amount":{"type":"number","exclusiveMinimum":0},"unit":{"type":"string","minLength":1,"maxLength":255},"areaAmount":{"type":"number","exclusiveMinimum":0},"areaUnit":{"type":"string","minLength":1,"maxLength":255}},"required":["amount","unit","areaAmount","areaUnit"],"additionalProperties":false},"max":{"type":"object","properties":{"amount":{"type":"number","exclusiveMinimum":0},"unit":{"type":"string","minLength":1,"maxLength":255},"areaAmount":{"type":"number","exclusiveMinimum":0},"areaUnit":{"type":"string","minLength":1,"maxLength":255}},"required":["amount","unit","areaAmount","areaUnit"],"additionalProperties":false}},"required":["crop","applicationMethod","min","max"],"additionalProperties":false}},"unitFit":{"type":"object","propertyNames":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"additionalProperties":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"fits"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"noGuidance"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"misfit"},"rateUnits":{"type":"array","items":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"minItems":1}},"required":["kind","rateUnits"],"additionalProperties":false}]},"required":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["provenance","rates","unitFit"],"additionalProperties":false},{"type":"null"}]}},"required":["vendor","cropRates"],"additionalProperties":false},{"type":"object","properties":{"vendor":{"type":"string","const":"unavailable"}},"required":["vendor"],"additionalProperties":false}]}
product.costRead catalog product costs. UI supported

Input shape documented

FieldLogical typePresence
catalogItemIdsarray of string (uuid)required
Full logical schema
{"type":"object","properties":{"catalogItemIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"minItems":1}},"required":["catalogItemIds"]}

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"productName":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"skuLabel":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"unitCost":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]}},"required":["catalogItemId","productName","skuLabel","unitCost"],"additionalProperties":false}}
product.cropRatesRead product crop application rates. UI supported

Input shape documented

FieldLogical typePresence
productIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["productId"],"additionalProperties":false}

Output shape documented

object | object | null

2 schema notes
  • $|0.rates[] refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.rates[] refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"anyOf":[{"oneOf":[{"type":"object","properties":{"provenance":{"type":"string","const":"compass"},"rates":{"type":"array","items":{"type":"object","properties":{"crop":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"unspecified"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"system"},"crop":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]}},"required":["kind","crop"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"other"},"name":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","name"],"additionalProperties":false}]},"applicationMethod":{"type":"string","minLength":1,"maxLength":255},"min":{"type":"object","properties":{"amount":{"type":"number","exclusiveMinimum":0},"unit":{"type":"string","minLength":1,"maxLength":255},"areaAmount":{"type":"number","exclusiveMinimum":0},"areaUnit":{"type":"string","minLength":1,"maxLength":255}},"required":["amount","unit","areaAmount","areaUnit"],"additionalProperties":false},"max":{"type":"object","properties":{"amount":{"type":"number","exclusiveMinimum":0},"unit":{"type":"string","minLength":1,"maxLength":255},"areaAmount":{"type":"number","exclusiveMinimum":0},"areaUnit":{"type":"string","minLength":1,"maxLength":255}},"required":["amount","unit","areaAmount","areaUnit"],"additionalProperties":false}},"required":["crop","applicationMethod","min","max"],"additionalProperties":false}},"unitFit":{"type":"object","propertyNames":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"additionalProperties":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"fits"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"noGuidance"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"misfit"},"rateUnits":{"type":"array","items":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"minItems":1}},"required":["kind","rateUnits"],"additionalProperties":false}]},"required":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["provenance","rates","unitFit"],"additionalProperties":false},{"type":"object","properties":{"provenance":{"type":"string","const":"dealer"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"rates":{"type":"array","items":{"type":"object","properties":{"crop":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"unspecified"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"system"},"crop":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]}},"required":["kind","crop"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"other"},"name":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","name"],"additionalProperties":false}]},"applicationMethod":{"anyOf":[{"type":"string","enum":["ground","aerial"]},{"type":"null"}]},"min":{"type":"number","exclusiveMinimum":0},"max":{"type":"number","exclusiveMinimum":0}},"required":["crop","applicationMethod","min","max"],"additionalProperties":false}},"sourceLabel":{"type":"string","minLength":1,"maxLength":255}},"required":["provenance","unit","rates","sourceLabel"],"additionalProperties":false}]},{"type":"null"}]}
product.deactivateDeactivate a product. Backend only

Input shape documented

FieldLogical typePresence
productIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["productId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["productId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unknown_product"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"still_carried"}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
product.equivalentsFind equivalent products. UI supported

Input shape documented

FieldLogical typePresence
skustringrequired
Full logical schema
{"type":"object","properties":{"sku":{"type":"string","minLength":1}},"required":["sku"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"source":{"type":"string","const":"answered"},"rows":{"type":"array","items":{"type":"object","properties":{"ref":{"type":"string","minLength":1,"maxLength":255},"name":{"type":"string","minLength":1,"maxLength":255},"carriedSku":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"activeIngredients":{"type":"string","minLength":1,"maxLength":1024}},"required":["ref","name","carriedSku","activeIngredients"],"additionalProperties":false}}},"required":["source","rows"],"additionalProperties":false},{"type":"object","properties":{"source":{"type":"string","const":"unavailable"}},"required":["source"],"additionalProperties":false}]}
product.importBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
rowsarray of objectrequired
7 schema notes
  • $.rows[] refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].pack.value refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].contactFirstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].contactLastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].contactEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].active runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].epaRegNumber refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"category":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"packageSize":{"type":"string","minLength":1,"maxLength":255},"pack":{"type":"object","properties":{"count":{"type":"integer","minimum":1,"maximum":9007199254740991},"value":{"type":"number","exclusiveMinimum":0},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["count","value","unit"]},"msrp":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"salesPrice":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"format":"money"},"manufacturer":{"type":"string","minLength":1,"maxLength":255},"supplier":{"type":"string","minLength":1,"maxLength":255},"contactFirstName":{"type":"string","minLength":1,"maxLength":100},"contactLastName":{"type":"string","minLength":1,"maxLength":100},"contactPhone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"contactEmail":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"supplierPrice":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"format":"money"},"active":{"type":"boolean"},"restrictedUse":{"type":"boolean"},"brand":{"type":"string","minLength":1,"maxLength":255},"epaRegNumber":{"type":"string","minLength":1}},"required":["sku","name","category","unit"]},"minItems":1}},"required":["rows"]}

Output shape documented

object | object

8 schema notes
  • $|1.error|3.rows[].facts refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|3.rows[].facts.contactFirstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|3.rows[].facts.contactLastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|3.rows[].facts.contactEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|3.rows[].facts.active runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|3.rows[].facts.epaRegNumber refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|3.rows[].facts.soldAs|0.pack.size.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.error|3.rows[].facts.soldAs|1.increment refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"received":{"type":"integer","minimum":0,"maximum":9007199254740991},"imported":{"type":"integer","minimum":0,"maximum":9007199254740991},"created":{"type":"integer","minimum":0,"maximum":9007199254740991},"catalogItems":{"type":"object","properties":{"created":{"type":"integer","minimum":0,"maximum":9007199254740991},"reused":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["created","reused"],"additionalProperties":false},"counterparties":{"type":"object","properties":{"created":{"type":"integer","minimum":0,"maximum":9007199254740991},"reused":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["created","reused"],"additionalProperties":false},"supplierMemberships":{"type":"object","properties":{"recorded":{"type":"integer","minimum":0,"maximum":9007199254740991},"unchanged":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["recorded","unchanged"],"additionalProperties":false},"supplierPrices":{"type":"object","properties":{"recorded":{"type":"integer","minimum":0,"maximum":9007199254740991},"unchanged":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["recorded","unchanged"],"additionalProperties":false},"skipped":{"type":"array","items":{"type":"object","properties":{"line":{"type":"integer","minimum":1,"maximum":9007199254740991},"sku":{"type":"string","minLength":1,"maxLength":64},"reason":{"type":"object","properties":{"code":{"type":"string","enum":["shadows_compass_product"]},"compassUid":{"type":"string","minLength":1}},"required":["code","compassUid"],"additionalProperties":false}},"required":["line","sku","reason"],"additionalProperties":false}},"retained":{"type":"array","items":{"type":"object","properties":{"line":{"type":"integer","minimum":1,"maximum":9007199254740991},"fields":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","minLength":1,"maxLength":255},"asserted":{"type":"string","minLength":1,"maxLength":5000},"stored":{"type":"string","minLength":1,"maxLength":5000}},"required":["field","asserted","stored"],"additionalProperties":false}}},"required":["line","fields"],"additionalProperties":false}}},"required":["received","imported","created","catalogItems","counterparties","supplierMemberships","supplierPrices","skipped"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["no_company","ambiguous_supplier_contact","not_bought","catalog_item_not_found","blend_priced_by_ingredients"]},"line":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["code"],"additionalProperties":false}]},{"type":"object","properties":{"line":{"type":"integer","minimum":1,"maximum":9007199254740991},"conflicts":{"type":"array","items":{"type":"object","properties":{"entity":{"type":"string","enum":["product","item","category","price","supplier"]},"field":{"type":"string","minLength":1,"maxLength":255},"sources":{"type":"array","items":{"type":"object","properties":{"line":{"type":"integer","minimum":1,"maximum":9007199254740991},"value":{"type":"string","minLength":1,"maxLength":5000}},"required":["line","value"],"additionalProperties":false},"minItems":1}},"required":["entity","field","sources"],"additionalProperties":false},"minItems":1},"code":{"type":"string","const":"converging_conflict"}},"required":["line","conflicts","code"],"additionalProperties":false},{"type":"object","properties":{"line":{"type":"integer","minimum":1,"maximum":9007199254740991},"field":{"type":"string","const":"msrp"},"code":{"type":"string","const":"unsupported_column"}},"required":["line","field","code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"changed_since_preview"},"rows":{"type":"array","items":{"type":"object","properties":{"line":{"type":"integer","minimum":1,"maximum":9007199254740991},"sku":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"generate"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"provided"},"code":{"type":"string","minLength":1,"maxLength":64}},"required":["kind","code"],"additionalProperties":false}]},"facts":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"category":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]},"msrp":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"salesPrice":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"format":"money"},"manufacturer":{"type":"string","minLength":1,"maxLength":255},"supplier":{"type":"string","minLength":1,"maxLength":255},"contactFirstName":{"type":"string","minLength":1,"maxLength":100},"contactLastName":{"type":"string","minLength":1,"maxLength":100},"contactPhone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"contactEmail":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"supplierPrice":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"format":"money"},"active":{"type":"boolean"},"restrictedUse":{"type":"boolean"},"brand":{"type":"string","minLength":1,"maxLength":255},"epaRegNumber":{"type":"string","minLength":1},"soldAs":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"packaged"},"pack":{"type":"object","properties":{"count":{"type":"integer","minimum":1,"maximum":9007199254740991},"size":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false}},"required":["count","size"],"additionalProperties":false}},"required":["_tag","pack"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"measured"},"unit":{"type":"string","enum":["lb","ton","gal","L","bu","cwt","acre"]},"increment":{"type":"string","format":"decimal","x-wire-kind":"Amount"}},"required":["_tag","unit","increment"],"additionalProperties":false}]}},"required":["name","category","active","soldAs"],"additionalProperties":false},"decision":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"reuse"},"retainedFields":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","minLength":1,"maxLength":255},"asserted":{"type":"string","minLength":1,"maxLength":5000},"stored":{"type":"string","minLength":1,"maxLength":5000}},"required":["field","asserted","stored"],"additionalProperties":false}},"retainedSnapshot":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","minLength":1,"maxLength":255},"stored":{"type":"string","minLength":1,"maxLength":5000}},"required":["field","stored"],"additionalProperties":false}},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sku":{"type":"string","minLength":1,"maxLength":64}},"required":["kind","catalogItemId","productId","sku"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"create"},"retainedFields":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","minLength":1,"maxLength":255},"asserted":{"type":"string","minLength":1,"maxLength":5000},"stored":{"type":"string","minLength":1,"maxLength":5000}},"required":["field","asserted","stored"],"additionalProperties":false}},"retainedSnapshot":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","minLength":1,"maxLength":255},"stored":{"type":"string","minLength":1,"maxLength":5000}},"required":["field","stored"],"additionalProperties":false}},"sku":{"type":"string","minLength":1,"maxLength":64},"product":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"new"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"existing"},"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","productId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"line"},"line":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["kind","line"],"additionalProperties":false}]}},"required":["kind","sku","product"],"additionalProperties":false}]}},"required":["line","sku","facts","decision"],"additionalProperties":false},"minItems":1,"maxItems":5000}},"required":["code","rows"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"ambiguous_identity"},"lines":{"type":"array","items":{"type":"integer","minimum":1,"maximum":9007199254740991},"minItems":1,"maxItems":5000}},"required":["code","lines"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"sku_held_by_other_product"},"line":{"type":"integer","minimum":1,"maximum":9007199254740991},"sku":{"type":"string","minLength":1,"maxLength":64},"holder":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"item"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","catalogItemId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"line"},"line":{"type":"integer","minimum":1,"maximum":9007199254740991}},"required":["kind","line"],"additionalProperties":false}]}},"required":["code","line","sku","holder"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"carry_refused"},"line":{"type":"integer","minimum":1,"maximum":9007199254740991},"reason":{"type":"string","enum":["already_carried","sku_unit_mismatch"]}},"required":["code","line","reason"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
product.refreshRegulatoryBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
productIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["productId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"refreshed":{"type":"boolean"},"refreshedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"}},"required":["refreshed","refreshedAt"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","const":"unknown_product"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_compass_product"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unknown_compass_product"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"rejected"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["code","status"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"rate_limited"},"retryAfterSeconds":{"type":"number","minimum":0}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"maintenance"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unavailable"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"superseded":{"type":"boolean","const":true}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"malformed"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
product.regulatoryRead product regulatory identity. UI supported

Input shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"ours"},"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","productId"]},{"type":"object","properties":{"kind":{"type":"string","const":"compass"},"uid":{"type":"string","minLength":1}},"required":["kind","uid"]}]}

Output shape documented

FieldLogical typePresence
identityobjectrequired
Full logical schema
{"type":"object","properties":{"identity":{"type":"object","properties":{"sku":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"null"}]},"name":{"type":"string","minLength":1,"maxLength":255},"searchName":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"manufacturer":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"epaRegNumber":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"categories":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"source":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"type":{"type":"string","minLength":1,"maxLength":255}},"required":["name","type"],"additionalProperties":false},{"type":"null"}]},"countries":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"isoCode2":{"type":"string","minLength":1,"maxLength":255},"isoCode3":{"type":"string","minLength":1,"maxLength":255}},"required":["name","isoCode2","isoCode3"],"additionalProperties":false}},"publication":{"anyOf":[{"type":"string","enum":["published","unpublished"]},{"type":"null"}]},"sourceUpdatedAt":{"anyOf":[{"type":"string","format":"date-time","x-wire-kind":"Instant"},{"type":"null"}]}},"required":["sku","name","searchName","manufacturer","epaRegNumber","categories","source","countries","publication","sourceUpdatedAt"],"additionalProperties":false}},"required":["identity"],"additionalProperties":false}
product.replaceCropRatesBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
productIdstring (uuid)required
ratesarray of objectrequired
1 schema note
  • $.rates[] refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"rates":{"type":"array","items":{"type":"object","properties":{"crop":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"unspecified"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"system"},"crop":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]}},"required":["kind","crop"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"other"},"name":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","name"],"additionalProperties":false}]},"applicationMethod":{"anyOf":[{"type":"string","enum":["ground","aerial"]},{"type":"null"}]},"min":{"type":"number","exclusiveMinimum":0},"max":{"type":"number","exclusiveMinimum":0}},"required":["crop","applicationMethod","min","max"],"additionalProperties":false}}},"required":["productId","rates"],"additionalProperties":false}

Output shape documented

object | object

1 schema note
  • $|0.value.rates[] refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"rates":{"type":"array","items":{"type":"object","properties":{"crop":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"unspecified"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"system"},"crop":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]}},"required":["kind","crop"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"other"},"name":{"type":"string","minLength":1,"maxLength":255}},"required":["kind","name"],"additionalProperties":false}]},"applicationMethod":{"anyOf":[{"type":"string","enum":["ground","aerial"]},{"type":"null"}]},"min":{"type":"number","exclusiveMinimum":0},"max":{"type":"number","exclusiveMinimum":0}},"required":["crop","applicationMethod","min","max"],"additionalProperties":false}}},"required":["productId","rates"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"product_not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_editable"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
product.searchMarketSearch market products. UI supported

Input shape documented

FieldLogical typePresence
qstringmay be omitted
companystring | nullmay be omitted
3 schema notes
  • $.q runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.q runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.company runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"q":{"type":"string"},"company":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}}}

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"compassUid":{"type":"string","minLength":1},"name":{"type":"string","minLength":1,"maxLength":255},"manufacturer":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"epaRegNumber":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"categories":{"type":"array","items":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}},"productId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"carried":{"anyOf":[{"type":"string","enum":["made","bought","blended","discontinued"]},{"type":"null"}]}},"required":["compassUid","name","manufacturer","epaRegNumber","categories","productId","carried"],"additionalProperties":false}}
product.setBlendIngredientBusiness procedure UI supported

Input shape documented

object | object

6 schema notes
  • $|0.analysis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.analysis.n refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.analysis.p2o5 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.analysis.k2o refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.analysis.s refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.lbPerGal refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"anyOf":[{"type":"object","properties":{"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"analysis":{"type":"object","properties":{"n":{"type":"number","minimum":0,"maximum":100},"p2o5":{"type":"number","minimum":0,"maximum":100},"k2o":{"type":"number","minimum":0,"maximum":100},"s":{"type":"number","minimum":0,"maximum":100}},"required":["n","p2o5","k2o","s"],"additionalProperties":false},"lbPerGal":{"type":"number","minimum":5,"maximum":15}},"required":["productId","analysis"],"additionalProperties":false},{"type":"object","properties":{"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"clear":{"type":"boolean","const":true}},"required":["productId","clear"],"additionalProperties":false}]}

Output shape documented

object | object

11 schema notes
  • $|0.value.form|0.analysis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.form|0.analysis.n refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.form|0.analysis.p2o5 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.form|0.analysis.k2o refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.form|0.analysis.s refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.form|1.analysis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.form|1.analysis.n refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.form|1.analysis.p2o5 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.form|1.analysis.k2o refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.form|1.analysis.s refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value.form|1.lbPerGal refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"form":{"anyOf":[{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dry"},"analysis":{"type":"object","properties":{"n":{"type":"number","minimum":0,"maximum":100},"p2o5":{"type":"number","minimum":0,"maximum":100},"k2o":{"type":"number","minimum":0,"maximum":100},"s":{"type":"number","minimum":0,"maximum":100}},"required":["n","p2o5","k2o","s"],"additionalProperties":false}},"required":["kind","analysis"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"liquid"},"analysis":{"type":"object","properties":{"n":{"type":"number","minimum":0,"maximum":100},"p2o5":{"type":"number","minimum":0,"maximum":100},"k2o":{"type":"number","minimum":0,"maximum":100},"s":{"type":"number","minimum":0,"maximum":100}},"required":["n","p2o5","k2o","s"],"additionalProperties":false},"lbPerGal":{"type":"number","minimum":5,"maximum":15}},"required":["kind","analysis","lbPerGal"],"additionalProperties":false}]},{"type":"null"}]}},"required":["productId","form"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"product_not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_blendable"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"lb_per_gal_required"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
product.suppliersRead product suppliers and prices. UI supported

Input shape documented

FieldLogical typePresence
productIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["productId"]}

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sku":{"type":"string","minLength":1,"maxLength":64},"productSkuLabel":{"type":"string","minLength":1,"maxLength":374},"supplierCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"supplierName":{"type":"string","minLength":1,"maxLength":255},"price":{"anyOf":[{"type":"object","properties":{"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"effectiveAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"}},"required":["amount","effectiveAt"],"additionalProperties":false},{"type":"null"}]}},"required":["catalogItemId","sku","productSkuLabel","supplierCompanyId","supplierName","price"],"additionalProperties":false}}
product.updateOwnBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
productIdstring (uuid)required
namestringrequired
category"herbicide" | "insecticide" | "fungicide" | "nematicide" | "miticide" | "fumigant" | "biopesticide" | "pgr" | "defoliant" | "desiccant" | "repellent" | "insect_growth_regulator" | "seed_treatment" | "seed_lubricant" | "seed" | "fertilizer" | "micronutrient" | "nutritional" | "manure" | "nitrogen_stabilizer" | "manure_treatment" | "biological" | "inoculant" | "biostimulant" | "adjuvant" | "tank_cleaner" | "equipment" | "service" | "other"required
manufacturerstringmay be omitted
brandstringmay be omitted
Full logical schema
{"type":"object","properties":{"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"category":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]},"manufacturer":{"type":"string","minLength":1,"maxLength":255},"brand":{"type":"string","minLength":1,"maxLength":255}},"required":["productId","name","category"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["productId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"product_not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_editable"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}

quote

Quotes, blend details, and documents

Quote versions and line work, pricing advice, blend ingredients, and grower-facing document and response fields.

quote.acreChoicesBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealIdstring (uuid)required
catalogItemIdsarray of string (uuid)required
Full logical schema
{"type":"object","properties":{"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"catalogItemIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["dealId","catalogItemIds"],"additionalProperties":false}

Output shape documented

FieldLogical typePresence
fieldsarray of objectrequired
choicesarray of objectrequired
2 schema notes
  • $.choices[].soldAs|0.pack.size.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.choices[].soldAs|1.increment refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"crop":{"type":"string","enum":["Almonds","Barley","Canola","Cherry","Corn","Cotton","Dry (Edible) Beans","Millet","Milo (Grain Sorghum)","Oats","Pea (Dry)","Peanuts","Popcorn","Potatoes","Rice","Soybean","Sugar Beets","Sunflowers","Tobacco","Wheat (HRW)","Wheat (Spring)","Wheat (SRW)","Other"]},"acres":{"type":"number","exclusiveMinimum":0,"maximum":200000,"format":"number"},"fieldLabel":{"type":"string","minLength":1}},"required":["fieldId","crop","acres","fieldLabel"],"additionalProperties":false}},"choices":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"fieldId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"price":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"soldAs":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"packaged"},"pack":{"type":"object","properties":{"count":{"type":"integer","minimum":1,"maximum":9007199254740991},"size":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false}},"required":["count","size"],"additionalProperties":false}},"required":["_tag","pack"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"measured"},"unit":{"type":"string","enum":["lb","ton","gal","L","bu","cwt","acre"]},"increment":{"type":"string","format":"decimal","x-wire-kind":"Amount"}},"required":["_tag","unit","increment"],"additionalProperties":false}]},"usability":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"computable"},"min":{"type":"number","exclusiveMinimum":0},"max":{"type":"number","exclusiveMinimum":0},"exact":{"anyOf":[{"type":"object","properties":{"min":{"type":"string","maxLength":40,"pattern":"^\\d+(\\.\\d+)?$"},"max":{"type":"string","maxLength":40,"pattern":"^\\d+(\\.\\d+)?$"}},"required":["min","max"],"additionalProperties":false},{"type":"null"}]}},"required":["kind","min","max","exact"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unavailable"},"reason":{"type":"string","enum":["vendorText","incompatibleSaleUnit"]}},"required":["kind","reason"],"additionalProperties":false}]}},"required":["catalogItemId","fieldId","sku","name","price","soldAs","usability"],"additionalProperties":false}}},"required":["fields","choices"],"additionalProperties":false}
quote.blendIngredientsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
Full logical schema
{"type":"object","properties":{},"additionalProperties":false}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
canBlendbooleanrequired
saveNewobject | objectrequired
11 schema notes
  • $.rows[].form|0.analysis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].form|0.analysis.n refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].form|0.analysis.p2o5 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].form|0.analysis.k2o refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].form|0.analysis.s refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].form|1.analysis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].form|1.analysis.n refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].form|1.analysis.p2o5 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].form|1.analysis.k2o refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].form|1.analysis.s refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.rows[].form|1.lbPerGal refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"saleUnit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"form":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dry"},"analysis":{"type":"object","properties":{"n":{"type":"number","minimum":0,"maximum":100},"p2o5":{"type":"number","minimum":0,"maximum":100},"k2o":{"type":"number","minimum":0,"maximum":100},"s":{"type":"number","minimum":0,"maximum":100}},"required":["n","p2o5","k2o","s"],"additionalProperties":false}},"required":["kind","analysis"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"liquid"},"analysis":{"type":"object","properties":{"n":{"type":"number","minimum":0,"maximum":100},"p2o5":{"type":"number","minimum":0,"maximum":100},"k2o":{"type":"number","minimum":0,"maximum":100},"s":{"type":"number","minimum":0,"maximum":100}},"required":["n","p2o5","k2o","s"],"additionalProperties":false},"lbPerGal":{"type":"number","minimum":5,"maximum":15}},"required":["kind","analysis","lbPerGal"],"additionalProperties":false}]},"offer":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"selectable"},"price":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","price"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unavailable"},"reason":{"type":"string","enum":["noPrice","discontinued"]}},"required":["_tag","reason"],"additionalProperties":false}]}},"required":["catalogItemId","productId","sku","name","saleUnit","form","offer"],"additionalProperties":false}},"canBlend":{"type":"boolean"},"saveNew":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]}},"required":["rows","canBlend","saveNew"],"additionalProperties":false}
quote.draftAdviceRead draft quote pricing advice. Backend only

Input shape documented

FieldLogical typePresence
dealIdstring (uuid)required
linesarray of objectrequired
orderDiscountobjectmay be omitted
pricingJustificationobjectmay be omitted
validUntilCalendarDaymay be omitted
3 schema notes
  • $.lines[].qty refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[].cut|1.fixed refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.pricingJustification refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lines":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"qty":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"cut":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"relative"},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000}},"required":["kind","adjustBps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pinned"},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","fixed"],"additionalProperties":false}]}},"required":["catalogItemId","qty"]}},"orderDiscount":{"type":"object","properties":{"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"description":{"type":"string","minLength":1,"maxLength":255}},"required":["adjustBps","description"],"additionalProperties":false},"pricingJustification":{"type":"object","properties":{"reasonKind":{"type":"string","enum":["price_match","loyalty","supply_driven","volume"]},"reasonNote":{"type":"string","minLength":1,"maxLength":5000}},"additionalProperties":false},"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["dealId","lines"]}

Output shape documented

object | object | object

3 schema notes
  • $|0.money.lines[].unitBeforeOrder refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.money.lines[].net refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.pricedLines[].unitBeforeOrder refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"ready"},"money":{"type":"object","properties":{"lines":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"root":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"unitBeforeOrder":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"net":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"listTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"subtotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"savings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"percentOffList":{"type":"integer","minimum":1,"maximum":100},"adjustment":{"type":"object","properties":{"scope":{"type":"string","enum":["line","order"]},"label":{"type":"string","minLength":1,"maxLength":255},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["scope","label","amount"],"additionalProperties":false},"replacement":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"unitMargin":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"lineMargin":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"marginStatus":{"type":"string","enum":["ok","below_cost","unknown"]}},"required":["catalogItemId","qty","root","unitBeforeOrder","net","listTotal","subtotal","total","savings","replacement","unitMargin","lineMargin","marginStatus"],"additionalProperties":false}},"listSubtotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"subtotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"orderAdjustment":{"type":"object","properties":{"scope":{"type":"string","enum":["line","order"]},"label":{"type":"string","minLength":1,"maxLength":255},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["scope","label","amount"],"additionalProperties":false},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"lineDiscountTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"savings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"noPositiveSaving":{"type":"boolean"},"orderCost":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"orderMargin":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"marginVerdict":{"type":"string","enum":["ok","yellow","red","unknown"]}},"required":["lines","listSubtotal","subtotal","total","lineDiscountTotal","savings","noPositiveSaving","orderCost","orderMargin","marginVerdict"],"additionalProperties":false}},"required":["kind","money"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"unpriceable"},"pricedLines":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"root":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"unitBeforeOrder":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"listTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"subtotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"adjustment":{"type":"object","properties":{"scope":{"type":"string","enum":["line","order"]},"label":{"type":"string","minLength":1,"maxLength":255},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["scope","label","amount"],"additionalProperties":false}},"required":["catalogItemId","root","unitBeforeOrder","listTotal","subtotal"],"additionalProperties":false}}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"invalid"},"code":{"type":"string","enum":["discount_exceeds_price","line_too_large"]}},"required":["kind","code"],"additionalProperties":false}]}
quote.growerDocumentBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
versionIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["versionId"]}

Output shape documented

object | object | object | object | object | object | object

43 schema notes
  • $|0.document.note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.document.grower.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.document.dealer.repEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.document.lines[].qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.document.lines[].cut|1.fixed refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.document.lines[].categories runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.document.note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.document.grower.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.document.dealer.repEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.document.lines[].qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.document.lines[].cut|1.fixed refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|1.document.lines[].categories runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|2.document.note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|2.document.grower.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|2.document.dealer.repEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|2.document.lines[].qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|2.document.lines[].cut|1.fixed refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|2.document.lines[].categories runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|2.reason runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|3.document.note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|3.document.grower.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|3.document.dealer.repEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|3.document.lines[].qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|3.document.lines[].cut|1.fixed refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|3.document.lines[].categories runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|4.document.note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|4.document.grower.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|4.document.dealer.repEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|4.document.lines[].qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|4.document.lines[].cut|1.fixed refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|4.document.lines[].categories runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|5.document.note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|5.document.grower.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|5.document.dealer.repEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|5.document.lines[].qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|5.document.lines[].cut|1.fixed refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|5.document.lines[].categories runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|6.document.note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|6.document.grower.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|6.document.dealer.repEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|6.document.lines[].qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|6.document.lines[].cut|1.fixed refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|6.document.lines[].categories runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"next":{"type":"string","const":"verdict"},"document":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"number":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"title":{"type":"string","minLength":1,"maxLength":255},"quotedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"customerName":{"type":"string","minLength":1,"maxLength":255},"note":{"type":"string","maxLength":5000},"sentAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"grower":{"type":"object","properties":{"contactName":{"type":"string","minLength":1,"maxLength":255},"accountName":{"type":"string","minLength":1,"maxLength":255},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"}},"required":["contactName","accountName"],"additionalProperties":false},"dealer":{"type":"object","properties":{"repName":{"type":"string","minLength":1,"maxLength":255},"repEmail":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"dealerName":{"type":"string","minLength":1,"maxLength":255},"dealerPhone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"dealerAddress":{"type":"string","minLength":1}},"additionalProperties":false},"brand":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"logoUrl":{"type":"string","format":"uri"}},"required":["name"],"additionalProperties":false},"dealershipId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lines":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"cut":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"relative"},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000}},"required":["kind","adjustBps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pinned"},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","fixed"],"additionalProperties":false}]},"price":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"listPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"percentOff":{"type":"integer","minimum":1,"maximum":100},"amount":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"categories":{"type":"array","items":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}}},"required":["sku","name","qty","price","amount","categories"],"additionalProperties":false}},"listTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"savings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"orderDiscount":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":255},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["label","amount"],"additionalProperties":false},"total":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"validity":{"type":"object","properties":{"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["validUntil"],"additionalProperties":false}},"required":["versionId","version","number","title","quotedAt","customerName","note","grower","dealer","dealershipId","accountId","lines","total","validity"],"additionalProperties":false}},"required":["next","document"],"additionalProperties":false},{"type":"object","properties":{"next":{"type":"string","const":"view"},"document":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"number":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"title":{"type":"string","minLength":1,"maxLength":255},"quotedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"customerName":{"type":"string","minLength":1,"maxLength":255},"note":{"type":"string","maxLength":5000},"sentAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"grower":{"type":"object","properties":{"contactName":{"type":"string","minLength":1,"maxLength":255},"accountName":{"type":"string","minLength":1,"maxLength":255},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"}},"required":["contactName","accountName"],"additionalProperties":false},"dealer":{"type":"object","properties":{"repName":{"type":"string","minLength":1,"maxLength":255},"repEmail":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"dealerName":{"type":"string","minLength":1,"maxLength":255},"dealerPhone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"dealerAddress":{"type":"string","minLength":1}},"additionalProperties":false},"brand":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"logoUrl":{"type":"string","format":"uri"}},"required":["name"],"additionalProperties":false},"dealershipId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lines":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"cut":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"relative"},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000}},"required":["kind","adjustBps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pinned"},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","fixed"],"additionalProperties":false}]},"price":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"listPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"percentOff":{"type":"integer","minimum":1,"maximum":100},"amount":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"categories":{"type":"array","items":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}}},"required":["sku","name","qty","price","amount","categories"],"additionalProperties":false}},"listTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"savings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"orderDiscount":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":255},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["label","amount"],"additionalProperties":false},"total":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"validity":{"type":"object","properties":{"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["validUntil"],"additionalProperties":false}},"required":["versionId","version","number","title","quotedAt","customerName","note","grower","dealer","dealershipId","accountId","lines","total","validity"],"additionalProperties":false}},"required":["next","document"],"additionalProperties":false},{"type":"object","properties":{"next":{"type":"string","const":"declined"},"document":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"number":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"title":{"type":"string","minLength":1,"maxLength":255},"quotedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"customerName":{"type":"string","minLength":1,"maxLength":255},"note":{"type":"string","maxLength":5000},"sentAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"grower":{"type":"object","properties":{"contactName":{"type":"string","minLength":1,"maxLength":255},"accountName":{"type":"string","minLength":1,"maxLength":255},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"}},"required":["contactName","accountName"],"additionalProperties":false},"dealer":{"type":"object","properties":{"repName":{"type":"string","minLength":1,"maxLength":255},"repEmail":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"dealerName":{"type":"string","minLength":1,"maxLength":255},"dealerPhone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"dealerAddress":{"type":"string","minLength":1}},"additionalProperties":false},"brand":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"logoUrl":{"type":"string","format":"uri"}},"required":["name"],"additionalProperties":false},"dealershipId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lines":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"cut":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"relative"},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000}},"required":["kind","adjustBps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pinned"},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","fixed"],"additionalProperties":false}]},"price":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"listPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"percentOff":{"type":"integer","minimum":1,"maximum":100},"amount":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"categories":{"type":"array","items":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}}},"required":["sku","name","qty","price","amount","categories"],"additionalProperties":false}},"listTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"savings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"orderDiscount":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":255},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["label","amount"],"additionalProperties":false},"total":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"validity":{"type":"object","properties":{"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["validUntil"],"additionalProperties":false}},"required":["versionId","version","number","title","quotedAt","customerName","note","grower","dealer","dealershipId","accountId","lines","total","validity"],"additionalProperties":false},"declinedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"reason":{"type":"string","maxLength":5000},"replacementVersionId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["next","document","declinedAt","reason","replacementVersionId"],"additionalProperties":false},{"type":"object","properties":{"next":{"type":"string","const":"accepted"},"document":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"number":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"title":{"type":"string","minLength":1,"maxLength":255},"quotedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"customerName":{"type":"string","minLength":1,"maxLength":255},"note":{"type":"string","maxLength":5000},"sentAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"grower":{"type":"object","properties":{"contactName":{"type":"string","minLength":1,"maxLength":255},"accountName":{"type":"string","minLength":1,"maxLength":255},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"}},"required":["contactName","accountName"],"additionalProperties":false},"dealer":{"type":"object","properties":{"repName":{"type":"string","minLength":1,"maxLength":255},"repEmail":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"dealerName":{"type":"string","minLength":1,"maxLength":255},"dealerPhone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"dealerAddress":{"type":"string","minLength":1}},"additionalProperties":false},"brand":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"logoUrl":{"type":"string","format":"uri"}},"required":["name"],"additionalProperties":false},"dealershipId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lines":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"cut":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"relative"},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000}},"required":["kind","adjustBps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pinned"},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","fixed"],"additionalProperties":false}]},"price":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"listPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"percentOff":{"type":"integer","minimum":1,"maximum":100},"amount":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"categories":{"type":"array","items":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}}},"required":["sku","name","qty","price","amount","categories"],"additionalProperties":false}},"listTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"savings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"orderDiscount":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":255},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["label","amount"],"additionalProperties":false},"total":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"validity":{"type":"object","properties":{"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["validUntil"],"additionalProperties":false}},"required":["versionId","version","number","title","quotedAt","customerName","note","grower","dealer","dealershipId","accountId","lines","total","validity"],"additionalProperties":false},"acceptedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"yours":{"type":"boolean"}},"required":["next","document","acceptedAt","yours"],"additionalProperties":false},{"type":"object","properties":{"next":{"type":"string","const":"superseded"},"document":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"number":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"title":{"type":"string","minLength":1,"maxLength":255},"quotedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"customerName":{"type":"string","minLength":1,"maxLength":255},"note":{"type":"string","maxLength":5000},"sentAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"grower":{"type":"object","properties":{"contactName":{"type":"string","minLength":1,"maxLength":255},"accountName":{"type":"string","minLength":1,"maxLength":255},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"}},"required":["contactName","accountName"],"additionalProperties":false},"dealer":{"type":"object","properties":{"repName":{"type":"string","minLength":1,"maxLength":255},"repEmail":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"dealerName":{"type":"string","minLength":1,"maxLength":255},"dealerPhone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"dealerAddress":{"type":"string","minLength":1}},"additionalProperties":false},"brand":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"logoUrl":{"type":"string","format":"uri"}},"required":["name"],"additionalProperties":false},"dealershipId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lines":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"cut":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"relative"},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000}},"required":["kind","adjustBps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pinned"},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","fixed"],"additionalProperties":false}]},"price":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"listPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"percentOff":{"type":"integer","minimum":1,"maximum":100},"amount":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"categories":{"type":"array","items":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}}},"required":["sku","name","qty","price","amount","categories"],"additionalProperties":false}},"listTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"savings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"orderDiscount":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":255},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["label","amount"],"additionalProperties":false},"total":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"validity":{"type":"object","properties":{"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["validUntil"],"additionalProperties":false}},"required":["versionId","version","number","title","quotedAt","customerName","note","grower","dealer","dealershipId","accountId","lines","total","validity"],"additionalProperties":false},"replacementVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["next","document","replacementVersionId"],"additionalProperties":false},{"type":"object","properties":{"next":{"type":"string","const":"expired"},"document":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"number":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"title":{"type":"string","minLength":1,"maxLength":255},"quotedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"customerName":{"type":"string","minLength":1,"maxLength":255},"note":{"type":"string","maxLength":5000},"sentAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"grower":{"type":"object","properties":{"contactName":{"type":"string","minLength":1,"maxLength":255},"accountName":{"type":"string","minLength":1,"maxLength":255},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"}},"required":["contactName","accountName"],"additionalProperties":false},"dealer":{"type":"object","properties":{"repName":{"type":"string","minLength":1,"maxLength":255},"repEmail":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"dealerName":{"type":"string","minLength":1,"maxLength":255},"dealerPhone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"dealerAddress":{"type":"string","minLength":1}},"additionalProperties":false},"brand":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"logoUrl":{"type":"string","format":"uri"}},"required":["name"],"additionalProperties":false},"dealershipId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lines":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"cut":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"relative"},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000}},"required":["kind","adjustBps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pinned"},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","fixed"],"additionalProperties":false}]},"price":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"listPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"percentOff":{"type":"integer","minimum":1,"maximum":100},"amount":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"categories":{"type":"array","items":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}}},"required":["sku","name","qty","price","amount","categories"],"additionalProperties":false}},"listTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"savings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"orderDiscount":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":255},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["label","amount"],"additionalProperties":false},"total":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"validity":{"type":"object","properties":{"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["validUntil"],"additionalProperties":false}},"required":["versionId","version","number","title","quotedAt","customerName","note","grower","dealer","dealershipId","accountId","lines","total","validity"],"additionalProperties":false}},"required":["next","document"],"additionalProperties":false},{"type":"object","properties":{"next":{"type":"string","const":"unpriced"},"document":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"number":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"title":{"type":"string","minLength":1,"maxLength":255},"quotedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"customerName":{"type":"string","minLength":1,"maxLength":255},"note":{"type":"string","maxLength":5000},"sentAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"grower":{"type":"object","properties":{"contactName":{"type":"string","minLength":1,"maxLength":255},"accountName":{"type":"string","minLength":1,"maxLength":255},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"}},"required":["contactName","accountName"],"additionalProperties":false},"dealer":{"type":"object","properties":{"repName":{"type":"string","minLength":1,"maxLength":255},"repEmail":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"dealerName":{"type":"string","minLength":1,"maxLength":255},"dealerPhone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"dealerAddress":{"type":"string","minLength":1}},"additionalProperties":false},"brand":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"logoUrl":{"type":"string","format":"uri"}},"required":["name"],"additionalProperties":false},"dealershipId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lines":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"cut":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"relative"},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000}},"required":["kind","adjustBps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pinned"},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","fixed"],"additionalProperties":false}]},"price":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"listPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"percentOff":{"type":"integer","minimum":1,"maximum":100},"amount":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"categories":{"type":"array","items":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}}},"required":["sku","name","qty","price","amount","categories"],"additionalProperties":false}},"listTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"savings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"orderDiscount":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":255},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["label","amount"],"additionalProperties":false},"total":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"validity":{"type":"object","properties":{"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["validUntil"],"additionalProperties":false}},"required":["versionId","version","number","title","quotedAt","customerName","note","grower","dealer","dealershipId","accountId","lines","total","validity"],"additionalProperties":false}},"required":["next","document"],"additionalProperties":false}]}
quote.growerDocumentPdfBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
versionIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["versionId"]}

Output shape documented

FieldLogical typePresence
urlstring (uri)required
fileNamestringrequired
Full logical schema
{"type":"object","properties":{"url":{"type":"string","format":"uri"},"fileName":{"type":"string","minLength":1,"maxLength":255}},"required":["url","fileName"],"additionalProperties":false}
quote.growerVerdictBusiness procedure UI supported

Input shape documented

object | object

1 schema note
  • $|1.reason runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"verdict":{"type":"string","enum":["accept"]}},"required":["versionId","verdict"]},{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"verdict":{"type":"string","enum":["decline"]},"reason":{"type":"string","maxLength":5000}},"required":["versionId","verdict"]}]}

Output shape documented

object | object

43 schema notes
  • $|0.value|0.document.note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|0.document.grower.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|0.document.dealer.repEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|0.document.lines[].qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|0.document.lines[].cut|1.fixed refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|0.document.lines[].categories runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|1.document.note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|1.document.grower.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|1.document.dealer.repEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|1.document.lines[].qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|1.document.lines[].cut|1.fixed refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|1.document.lines[].categories runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|2.document.note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|2.document.grower.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|2.document.dealer.repEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|2.document.lines[].qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|2.document.lines[].cut|1.fixed refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|2.document.lines[].categories runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|2.reason runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|3.document.note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|3.document.grower.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|3.document.dealer.repEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|3.document.lines[].qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|3.document.lines[].cut|1.fixed refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|3.document.lines[].categories runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|4.document.note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|4.document.grower.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|4.document.dealer.repEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|4.document.lines[].qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|4.document.lines[].cut|1.fixed refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|4.document.lines[].categories runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|5.document.note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|5.document.grower.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|5.document.dealer.repEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|5.document.lines[].qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|5.document.lines[].cut|1.fixed refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|5.document.lines[].categories runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|6.document.note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|6.document.grower.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|6.document.dealer.repEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|6.document.lines[].qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|6.document.lines[].cut|1.fixed refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $|0.value|6.document.lines[].categories runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"oneOf":[{"type":"object","properties":{"next":{"type":"string","const":"verdict"},"document":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"number":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"title":{"type":"string","minLength":1,"maxLength":255},"quotedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"customerName":{"type":"string","minLength":1,"maxLength":255},"note":{"type":"string","maxLength":5000},"sentAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"grower":{"type":"object","properties":{"contactName":{"type":"string","minLength":1,"maxLength":255},"accountName":{"type":"string","minLength":1,"maxLength":255},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"}},"required":["contactName","accountName"],"additionalProperties":false},"dealer":{"type":"object","properties":{"repName":{"type":"string","minLength":1,"maxLength":255},"repEmail":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"dealerName":{"type":"string","minLength":1,"maxLength":255},"dealerPhone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"dealerAddress":{"type":"string","minLength":1}},"additionalProperties":false},"brand":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"logoUrl":{"type":"string","format":"uri"}},"required":["name"],"additionalProperties":false},"dealershipId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lines":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"cut":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"relative"},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000}},"required":["kind","adjustBps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pinned"},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","fixed"],"additionalProperties":false}]},"price":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"listPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"percentOff":{"type":"integer","minimum":1,"maximum":100},"amount":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"categories":{"type":"array","items":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}}},"required":["sku","name","qty","price","amount","categories"],"additionalProperties":false}},"listTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"savings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"orderDiscount":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":255},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["label","amount"],"additionalProperties":false},"total":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"validity":{"type":"object","properties":{"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["validUntil"],"additionalProperties":false}},"required":["versionId","version","number","title","quotedAt","customerName","note","grower","dealer","dealershipId","accountId","lines","total","validity"],"additionalProperties":false}},"required":["next","document"],"additionalProperties":false},{"type":"object","properties":{"next":{"type":"string","const":"view"},"document":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"number":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"title":{"type":"string","minLength":1,"maxLength":255},"quotedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"customerName":{"type":"string","minLength":1,"maxLength":255},"note":{"type":"string","maxLength":5000},"sentAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"grower":{"type":"object","properties":{"contactName":{"type":"string","minLength":1,"maxLength":255},"accountName":{"type":"string","minLength":1,"maxLength":255},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"}},"required":["contactName","accountName"],"additionalProperties":false},"dealer":{"type":"object","properties":{"repName":{"type":"string","minLength":1,"maxLength":255},"repEmail":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"dealerName":{"type":"string","minLength":1,"maxLength":255},"dealerPhone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"dealerAddress":{"type":"string","minLength":1}},"additionalProperties":false},"brand":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"logoUrl":{"type":"string","format":"uri"}},"required":["name"],"additionalProperties":false},"dealershipId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lines":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"cut":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"relative"},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000}},"required":["kind","adjustBps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pinned"},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","fixed"],"additionalProperties":false}]},"price":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"listPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"percentOff":{"type":"integer","minimum":1,"maximum":100},"amount":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"categories":{"type":"array","items":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}}},"required":["sku","name","qty","price","amount","categories"],"additionalProperties":false}},"listTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"savings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"orderDiscount":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":255},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["label","amount"],"additionalProperties":false},"total":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"validity":{"type":"object","properties":{"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["validUntil"],"additionalProperties":false}},"required":["versionId","version","number","title","quotedAt","customerName","note","grower","dealer","dealershipId","accountId","lines","total","validity"],"additionalProperties":false}},"required":["next","document"],"additionalProperties":false},{"type":"object","properties":{"next":{"type":"string","const":"declined"},"document":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"number":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"title":{"type":"string","minLength":1,"maxLength":255},"quotedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"customerName":{"type":"string","minLength":1,"maxLength":255},"note":{"type":"string","maxLength":5000},"sentAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"grower":{"type":"object","properties":{"contactName":{"type":"string","minLength":1,"maxLength":255},"accountName":{"type":"string","minLength":1,"maxLength":255},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"}},"required":["contactName","accountName"],"additionalProperties":false},"dealer":{"type":"object","properties":{"repName":{"type":"string","minLength":1,"maxLength":255},"repEmail":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"dealerName":{"type":"string","minLength":1,"maxLength":255},"dealerPhone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"dealerAddress":{"type":"string","minLength":1}},"additionalProperties":false},"brand":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"logoUrl":{"type":"string","format":"uri"}},"required":["name"],"additionalProperties":false},"dealershipId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lines":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"cut":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"relative"},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000}},"required":["kind","adjustBps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pinned"},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","fixed"],"additionalProperties":false}]},"price":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"listPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"percentOff":{"type":"integer","minimum":1,"maximum":100},"amount":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"categories":{"type":"array","items":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}}},"required":["sku","name","qty","price","amount","categories"],"additionalProperties":false}},"listTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"savings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"orderDiscount":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":255},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["label","amount"],"additionalProperties":false},"total":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"validity":{"type":"object","properties":{"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["validUntil"],"additionalProperties":false}},"required":["versionId","version","number","title","quotedAt","customerName","note","grower","dealer","dealershipId","accountId","lines","total","validity"],"additionalProperties":false},"declinedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"reason":{"type":"string","maxLength":5000},"replacementVersionId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["next","document","declinedAt","reason","replacementVersionId"],"additionalProperties":false},{"type":"object","properties":{"next":{"type":"string","const":"accepted"},"document":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"number":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"title":{"type":"string","minLength":1,"maxLength":255},"quotedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"customerName":{"type":"string","minLength":1,"maxLength":255},"note":{"type":"string","maxLength":5000},"sentAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"grower":{"type":"object","properties":{"contactName":{"type":"string","minLength":1,"maxLength":255},"accountName":{"type":"string","minLength":1,"maxLength":255},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"}},"required":["contactName","accountName"],"additionalProperties":false},"dealer":{"type":"object","properties":{"repName":{"type":"string","minLength":1,"maxLength":255},"repEmail":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"dealerName":{"type":"string","minLength":1,"maxLength":255},"dealerPhone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"dealerAddress":{"type":"string","minLength":1}},"additionalProperties":false},"brand":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"logoUrl":{"type":"string","format":"uri"}},"required":["name"],"additionalProperties":false},"dealershipId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lines":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"cut":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"relative"},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000}},"required":["kind","adjustBps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pinned"},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","fixed"],"additionalProperties":false}]},"price":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"listPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"percentOff":{"type":"integer","minimum":1,"maximum":100},"amount":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"categories":{"type":"array","items":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}}},"required":["sku","name","qty","price","amount","categories"],"additionalProperties":false}},"listTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"savings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"orderDiscount":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":255},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["label","amount"],"additionalProperties":false},"total":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"validity":{"type":"object","properties":{"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["validUntil"],"additionalProperties":false}},"required":["versionId","version","number","title","quotedAt","customerName","note","grower","dealer","dealershipId","accountId","lines","total","validity"],"additionalProperties":false},"acceptedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"yours":{"type":"boolean"}},"required":["next","document","acceptedAt","yours"],"additionalProperties":false},{"type":"object","properties":{"next":{"type":"string","const":"superseded"},"document":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"number":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"title":{"type":"string","minLength":1,"maxLength":255},"quotedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"customerName":{"type":"string","minLength":1,"maxLength":255},"note":{"type":"string","maxLength":5000},"sentAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"grower":{"type":"object","properties":{"contactName":{"type":"string","minLength":1,"maxLength":255},"accountName":{"type":"string","minLength":1,"maxLength":255},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"}},"required":["contactName","accountName"],"additionalProperties":false},"dealer":{"type":"object","properties":{"repName":{"type":"string","minLength":1,"maxLength":255},"repEmail":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"dealerName":{"type":"string","minLength":1,"maxLength":255},"dealerPhone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"dealerAddress":{"type":"string","minLength":1}},"additionalProperties":false},"brand":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"logoUrl":{"type":"string","format":"uri"}},"required":["name"],"additionalProperties":false},"dealershipId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lines":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"cut":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"relative"},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000}},"required":["kind","adjustBps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pinned"},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","fixed"],"additionalProperties":false}]},"price":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"listPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"percentOff":{"type":"integer","minimum":1,"maximum":100},"amount":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"categories":{"type":"array","items":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}}},"required":["sku","name","qty","price","amount","categories"],"additionalProperties":false}},"listTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"savings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"orderDiscount":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":255},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["label","amount"],"additionalProperties":false},"total":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"validity":{"type":"object","properties":{"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["validUntil"],"additionalProperties":false}},"required":["versionId","version","number","title","quotedAt","customerName","note","grower","dealer","dealershipId","accountId","lines","total","validity"],"additionalProperties":false},"replacementVersionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["next","document","replacementVersionId"],"additionalProperties":false},{"type":"object","properties":{"next":{"type":"string","const":"expired"},"document":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"number":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"title":{"type":"string","minLength":1,"maxLength":255},"quotedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"customerName":{"type":"string","minLength":1,"maxLength":255},"note":{"type":"string","maxLength":5000},"sentAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"grower":{"type":"object","properties":{"contactName":{"type":"string","minLength":1,"maxLength":255},"accountName":{"type":"string","minLength":1,"maxLength":255},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"}},"required":["contactName","accountName"],"additionalProperties":false},"dealer":{"type":"object","properties":{"repName":{"type":"string","minLength":1,"maxLength":255},"repEmail":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"dealerName":{"type":"string","minLength":1,"maxLength":255},"dealerPhone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"dealerAddress":{"type":"string","minLength":1}},"additionalProperties":false},"brand":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"logoUrl":{"type":"string","format":"uri"}},"required":["name"],"additionalProperties":false},"dealershipId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lines":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"cut":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"relative"},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000}},"required":["kind","adjustBps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pinned"},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","fixed"],"additionalProperties":false}]},"price":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"listPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"percentOff":{"type":"integer","minimum":1,"maximum":100},"amount":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"categories":{"type":"array","items":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}}},"required":["sku","name","qty","price","amount","categories"],"additionalProperties":false}},"listTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"savings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"orderDiscount":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":255},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["label","amount"],"additionalProperties":false},"total":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"validity":{"type":"object","properties":{"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["validUntil"],"additionalProperties":false}},"required":["versionId","version","number","title","quotedAt","customerName","note","grower","dealer","dealershipId","accountId","lines","total","validity"],"additionalProperties":false}},"required":["next","document"],"additionalProperties":false},{"type":"object","properties":{"next":{"type":"string","const":"unpriced"},"document":{"type":"object","properties":{"versionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"number":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"title":{"type":"string","minLength":1,"maxLength":255},"quotedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"customerName":{"type":"string","minLength":1,"maxLength":255},"note":{"type":"string","maxLength":5000},"sentAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"grower":{"type":"object","properties":{"contactName":{"type":"string","minLength":1,"maxLength":255},"accountName":{"type":"string","minLength":1,"maxLength":255},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"}},"required":["contactName","accountName"],"additionalProperties":false},"dealer":{"type":"object","properties":{"repName":{"type":"string","minLength":1,"maxLength":255},"repEmail":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"dealerName":{"type":"string","minLength":1,"maxLength":255},"dealerPhone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"dealerAddress":{"type":"string","minLength":1}},"additionalProperties":false},"brand":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"logoUrl":{"type":"string","format":"uri"}},"required":["name"],"additionalProperties":false},"dealershipId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lines":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"cut":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"relative"},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000}},"required":["kind","adjustBps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pinned"},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","fixed"],"additionalProperties":false}]},"price":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"listPrice":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"percentOff":{"type":"integer","minimum":1,"maximum":100},"amount":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"categories":{"type":"array","items":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}}},"required":["sku","name","qty","price","amount","categories"],"additionalProperties":false}},"listTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"savings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"orderDiscount":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":255},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["label","amount"],"additionalProperties":false},"total":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"validity":{"type":"object","properties":{"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["validUntil"],"additionalProperties":false}},"required":["versionId","version","number","title","quotedAt","customerName","note","grower","dealer","dealershipId","accountId","lines","total","validity"],"additionalProperties":false}},"required":["next","document"],"additionalProperties":false}]}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"not":{}}},"required":["ok","error"],"additionalProperties":false}]}
quote.operativeBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealId"]}

Output shape documented

object | null

6 schema notes
  • $.version.note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.version.pricingJustification refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[].qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[].cut|1.fixed refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.money.lines[].unitBeforeOrder refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.money.lines[].net refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"anyOf":[{"type":"object","properties":{"version":{"type":"object","properties":{"_tag":{"type":"string","enum":["current","superseded","accepted"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"note":{"type":"string","maxLength":5000},"createdAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"supersededAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"total":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"revisedBy":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"orderDiscount":{"type":"object","properties":{"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"description":{"type":"string","minLength":1,"maxLength":255}},"required":["adjustBps","description"],"additionalProperties":false},"pricingJustification":{"type":"object","properties":{"reasonKind":{"type":"string","enum":["price_match","loyalty","supply_driven","volume"]},"reasonNote":{"type":"string","minLength":1,"maxLength":5000}},"additionalProperties":false}},"required":["_tag","id","dealId","version","validUntil","note","createdAt","total","revisedBy"],"additionalProperties":false},"lines":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"cut":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"relative"},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000}},"required":["kind","adjustBps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pinned"},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","fixed"],"additionalProperties":false}]},"price":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]}},"required":["sku","name","qty","catalogItemId","price"],"additionalProperties":false}},"money":{"anyOf":[{"type":"object","properties":{"listSubtotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"subtotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"orderAdjustment":{"type":"object","properties":{"scope":{"type":"string","enum":["line","order"]},"label":{"type":"string","minLength":1,"maxLength":255},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["scope","label","amount"],"additionalProperties":false},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"lineDiscountTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"savings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"noPositiveSaving":{"type":"boolean"},"lines":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"root":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"unitBeforeOrder":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"net":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"listTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"subtotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"adjustment":{"type":"object","properties":{"scope":{"type":"string","enum":["line","order"]},"label":{"type":"string","minLength":1,"maxLength":255},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["scope","label","amount"],"additionalProperties":false}},"required":["catalogItemId","root","unitBeforeOrder","net","listTotal","subtotal"],"additionalProperties":false}}},"required":["listSubtotal","subtotal","total","lineDiscountTotal","savings","noPositiveSaving","lines"],"additionalProperties":false},{"type":"null"}]}},"required":["version","lines","money"],"additionalProperties":false},{"type":"null"}]}
quote.saveBlendBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
kind"dry" | "liquid"required
picksarray of objectrequired
13 schema notes
  • $ refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.picks[].rate refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.picks[].form|0.analysis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.picks[].form|0.analysis.n refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.picks[].form|0.analysis.p2o5 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.picks[].form|0.analysis.k2o refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.picks[].form|0.analysis.s refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.picks[].form|1.analysis refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.picks[].form|1.analysis.n refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.picks[].form|1.analysis.p2o5 refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.picks[].form|1.analysis.k2o refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.picks[].form|1.analysis.s refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.picks[].form|1.lbPerGal refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"kind":{"type":"string","enum":["dry","liquid"]},"picks":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"rate":{"type":"number","minimum":0,"maximum":2000},"form":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"dry"},"analysis":{"type":"object","properties":{"n":{"type":"number","minimum":0,"maximum":100},"p2o5":{"type":"number","minimum":0,"maximum":100},"k2o":{"type":"number","minimum":0,"maximum":100},"s":{"type":"number","minimum":0,"maximum":100}},"required":["n","p2o5","k2o","s"],"additionalProperties":false}},"required":["kind","analysis"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"liquid"},"analysis":{"type":"object","properties":{"n":{"type":"number","minimum":0,"maximum":100},"p2o5":{"type":"number","minimum":0,"maximum":100},"k2o":{"type":"number","minimum":0,"maximum":100},"s":{"type":"number","minimum":0,"maximum":100}},"required":["n","p2o5","k2o","s"],"additionalProperties":false},"lbPerGal":{"type":"number","minimum":5,"maximum":15}},"required":["kind","analysis","lbPerGal"],"additionalProperties":false}]}},"required":["catalogItemId","rate","form"],"additionalProperties":false},"minItems":2,"maxItems":10}},"required":["kind","picks"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255}},"required":["catalogItemId","sku","name"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_an_ingredient"},"name":{"type":"string","minLength":1,"maxLength":255}},"required":["code","name"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"ingredient_facts_changed"},"name":{"type":"string","minLength":1,"maxLength":255}},"required":["code","name"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"sku_taken"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"save_conflict"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
quote.versionsByDealBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealId"]}

Output shape documented

array of object

1 schema note
  • $[].note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"array","items":{"type":"object","properties":{"_tag":{"type":"string","enum":["current","superseded","accepted"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"note":{"type":"string","maxLength":5000},"createdAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"supersededAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"total":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"revisedBy":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]}},"required":["_tag","id","dealId","version","validUntil","note","createdAt","total","revisedBy"],"additionalProperties":false}}
quote.versionWorkBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealIdstring (uuid)required
versionstringrequired
Full logical schema
{"type":"object","properties":{"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"string","pattern":"^v[1-9]\\d*$"}},"required":["dealId","version"]}

Output shape documented

object | null

6 schema notes
  • $.version.note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.version.pricingJustification refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[].qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[].cut|1.fixed refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.money.lines[].unitBeforeOrder refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.money.lines[].net refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"anyOf":[{"type":"object","properties":{"version":{"type":"object","properties":{"_tag":{"type":"string","enum":["current","superseded","accepted"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"version":{"type":"integer","minimum":0,"maximum":9007199254740991},"validUntil":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"note":{"type":"string","maxLength":5000},"createdAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"supersededAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"total":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]},"revisedBy":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"orderDiscount":{"type":"object","properties":{"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"description":{"type":"string","minLength":1,"maxLength":255}},"required":["adjustBps","description"],"additionalProperties":false},"pricingJustification":{"type":"object","properties":{"reasonKind":{"type":"string","enum":["price_match","loyalty","supply_driven","volume"]},"reasonNote":{"type":"string","minLength":1,"maxLength":5000}},"additionalProperties":false}},"required":["_tag","id","dealId","version","validUntil","note","createdAt","total","revisedBy"],"additionalProperties":false},"lines":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"cut":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"relative"},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000}},"required":["kind","adjustBps"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"pinned"},"fixed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","fixed"],"additionalProperties":false}]},"price":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]}},"required":["sku","name","qty","catalogItemId","price"],"additionalProperties":false}},"money":{"anyOf":[{"type":"object","properties":{"listSubtotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"subtotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"orderAdjustment":{"type":"object","properties":{"scope":{"type":"string","enum":["line","order"]},"label":{"type":"string","minLength":1,"maxLength":255},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["scope","label","amount"],"additionalProperties":false},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"lineDiscountTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"savings":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"noPositiveSaving":{"type":"boolean"},"lines":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"root":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"unitBeforeOrder":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"net":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"listTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"subtotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"adjustment":{"type":"object","properties":{"scope":{"type":"string","enum":["line","order"]},"label":{"type":"string","minLength":1,"maxLength":255},"adjustBps":{"type":"integer","minimum":-10000,"maximum":10000},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["scope","label","amount"],"additionalProperties":false}},"required":["catalogItemId","root","unitBeforeOrder","net","listTotal","subtotal"],"additionalProperties":false}}},"required":["listSubtotal","subtotal","total","lineDiscountTotal","savings","noPositiveSaving","lines"],"additionalProperties":false},{"type":"null"}]}},"required":["version","lines","money"],"additionalProperties":false},{"type":"null"}]}

saleOrder

Sales orders

Sales-order detail, deal association, and cancellation result fields.

saleOrder.byDealBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dealIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealId"]}

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ref":{"type":"string","minLength":1,"maxLength":255},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["open","cancelled"]},"confirmedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"paymentIntent":{"anyOf":[{"oneOf":[{"type":"object","properties":{"method":{"type":"string","const":"cfi"}},"required":["method"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","const":"other"}},"required":["method"],"additionalProperties":false}]},{"type":"null"}]},"fulfilled":{"type":"object","properties":{"itemsFulfilled":{"type":"integer","minimum":0,"maximum":9007199254740991},"itemsTotal":{"type":"integer","minimum":0,"maximum":9007199254740991},"state":{"type":"string","enum":["open","complete"]}},"required":["itemsFulfilled","itemsTotal","state"],"additionalProperties":false}},"required":["id","ref","dealId","status","confirmedAt","paymentIntent","fulfilled"],"additionalProperties":false}}
saleOrder.byIdBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
idstring (uuid)required
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"]}

Output shape documented

FieldLogical typePresence
idstring (uuid)required
refstringrequired
dealIdstring (uuid)required
status"open" | "cancelled"required
confirmedAtInstantrequired
paymentIntentobject | object | nullrequired
fulfilledobjectrequired
dealTitlestringrequired
heldarray of stringrequired
verdictsobjectrequired
confirmPlanVerdictobject | object | object | objectrequired
dealVerdictsobjectrequired
Full logical schema
{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ref":{"type":"string","minLength":1,"maxLength":255},"dealId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","enum":["open","cancelled"]},"confirmedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"paymentIntent":{"anyOf":[{"oneOf":[{"type":"object","properties":{"method":{"type":"string","const":"cfi"}},"required":["method"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","const":"other"}},"required":["method"],"additionalProperties":false}]},{"type":"null"}]},"fulfilled":{"type":"object","properties":{"itemsFulfilled":{"type":"integer","minimum":0,"maximum":9007199254740991},"itemsTotal":{"type":"integer","minimum":0,"maximum":9007199254740991},"state":{"type":"string","enum":["open","complete"]}},"required":["itemsFulfilled","itemsTotal","state"],"additionalProperties":false},"dealTitle":{"type":"string","minLength":1,"maxLength":255},"held":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"verdicts":{"type":"object","properties":{"cancel":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["order_line_billed","not_open"]}},"required":["status","error"],"additionalProperties":false}]},"confirm":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["order_line_billed","not_open"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["cancel","confirm"],"additionalProperties":false},"confirmPlanVerdict":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["already_confirmed"]}},"required":["status","error"],"additionalProperties":false}]},"dealVerdicts":{"type":"object","properties":{"stageQuote":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["unpriceable_line","not_fulfilled","not_invoiced","not_paid","not_discardable"]}},"required":["status","error"],"additionalProperties":false}]},"lose":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["unpriceable_line","not_fulfilled","not_invoiced","not_paid","not_discardable"]}},"required":["status","error"],"additionalProperties":false}]},"advanceToAccept":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["unpriceable_line","not_fulfilled","not_invoiced","not_paid","not_discardable"]}},"required":["status","error"],"additionalProperties":false}]},"reviseQuote":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["unpriceable_line","not_fulfilled","not_invoiced","not_paid","not_discardable"]}},"required":["status","error"],"additionalProperties":false}]},"win":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["unpriceable_line","not_fulfilled","not_invoiced","not_paid","not_discardable"]}},"required":["status","error"],"additionalProperties":false}]},"discard":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["unpriceable_line","not_fulfilled","not_invoiced","not_paid","not_discardable"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["stageQuote","lose","advanceToAccept","reviseQuote","win","discard"],"additionalProperties":false}},"required":["id","ref","dealId","status","confirmedAt","paymentIntent","fulfilled","dealTitle","held","verdicts","confirmPlanVerdict","dealVerdicts"],"additionalProperties":false}
saleOrder.cancelBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
saleOrderIdstring (uuid)required
reasonstringrequired
Full logical schema
{"type":"object","properties":{"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reason":{"type":"string","minLength":1,"maxLength":5000}},"required":["saleOrderId","reason"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["saleOrderId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["not_open","order_line_billed"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}

shipment

Shipment tracking

Shipment list and delivery-detail update and completion fields.

shipment.deliverBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
shipmentIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"shipmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["shipmentId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"shipmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["shipmentId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_in_transit"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_outbound"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"delivery_tracking_off"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
shipment.growerByOrderBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
dealerstring (uuid)required
orderIdstring (uuid)required
shipmentIdstring (uuid)may be omitted
Full logical schema
{"type":"object","properties":{"dealer":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"orderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"shipmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["dealer","orderId"],"additionalProperties":false}

Output shape documented

FieldLogical typePresence
rowsarray of object | objectrequired
totalintegerrequired
nextCursorstring | nullrequired
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"inTransit"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"carrier":{"type":"string","minLength":1,"maxLength":255},"tracking":{"type":"string","minLength":1,"maxLength":255},"eta":{"type":"string","format":"date-time","x-zod-type":"date"},"shippedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"lineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"statusLabel":{"type":"string","enum":["In transit","Delivered","Received"]}},"required":["_tag","id","lineFulfillmentId","statusLabel"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"received"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"carrier":{"type":"string","minLength":1,"maxLength":255},"tracking":{"type":"string","minLength":1,"maxLength":255},"eta":{"type":"string","format":"date-time","x-zod-type":"date"},"shippedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"receivedAt":{"type":"string","format":"date-time","x-zod-type":"date"},"lineFulfillmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"statusLabel":{"type":"string","enum":["In transit","Delivered","Received"]}},"required":["_tag","id","receivedAt","lineFulfillmentId","statusLabel"],"additionalProperties":false}]}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["rows","total","nextCursor"],"additionalProperties":false}
shipment.indexBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
sort"latestShipped"may be omitted
limitintegermay be omitted
cursorstring | nullmay be omitted
4 schema notes
  • $.sort runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"sort":{"type":"string","enum":["latestShipped"]},"limit":{"type":"integer","minimum":1,"maximum":200},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
totalintegerrequired
nextCursorstring | nullrequired
facetsobjectrequired
1 schema note
  • $.rows[].timeZone refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"saleOrderId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"accountId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"orderNumber":{"type":"integer","minimum":1001,"maximum":9007199254740991,"format":"counter"},"accountName":{"type":"string","minLength":1,"maxLength":255},"destination":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"shippedAt":{"anyOf":[{"type":"string","format":"date-time","x-wire-kind":"Instant"},{"type":"null"}]},"status":{"anyOf":[{"type":"string","const":"inTransit"},{"type":"string","const":"received"}]},"statusLabel":{"type":"string","minLength":1,"maxLength":255},"deliveredDay":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"carrier":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"tracking":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"eta":{"anyOf":[{"type":"string","format":"date-time","x-wire-kind":"Instant"},{"type":"null"}]},"etaDay":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"timeZone":{"type":"string"},"driver":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"driverPhone":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"vehicle":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"verdicts":{"type":"object","properties":{"receive":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["not_inbound","not_outbound","delivery_tracking_off"]}},"required":["status","error"],"additionalProperties":false}]},"deliver":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["not_inbound","not_outbound","delivery_tracking_off"]}},"required":["status","error"],"additionalProperties":false}]},"updateDetails":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"elsewhere"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["not_inbound","not_outbound","delivery_tracking_off"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["receive","deliver","updateDetails"],"additionalProperties":false}},"required":["id","saleOrderId","accountId","orderNumber","accountName","destination","shippedAt","status","statusLabel","deliveredDay","carrier","tracking","eta","etaDay","timeZone","driver","driverPhone","vehicle","verdicts"],"additionalProperties":false}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"facets":{"type":"object","properties":{},"additionalProperties":false}},"required":["rows","total","nextCursor","facets"],"additionalProperties":false}
shipment.updateDetailsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
shipmentIdstring (uuid)required
detailsobjectrequired
2 schema notes
  • $.details refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.details.eta runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"shipmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"details":{"type":"object","properties":{"carrier":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"tracking":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"driver":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"driverPhone":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"vehicle":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"eta":{"anyOf":[{"type":"string","format":"date-time","x-zod-type":"date"},{"type":"null"}]}},"additionalProperties":false}},"required":["shipmentId","details"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"shipmentId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["shipmentId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_in_transit"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_outbound"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"delivery_tracking_off"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}

stock

Warehouse stock

Query and result shapes for supply needs, warehouse inbound stock, warehouse levels, and warehouse lots.

stock.blendDemandBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
Full logical schema
{"type":"object","properties":{},"additionalProperties":false}

Output shape documented

FieldLogical typePresence
cardsarray of objectrequired
rowsarray of objectrequired
totalsarray of objectrequired
Full logical schema
{"type":"object","properties":{"cards":{"type":"array","items":{"type":"object","properties":{"nutrient":{"type":"string","enum":["n","p2o5","k2o","s"]},"neededLb":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"inStockLb":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"sources":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"coverage":{"anyOf":[{"type":"number","format":"percent"},{"type":"null"}]}},"required":["nutrient","neededLb","inStockLb","sources","coverage"],"additionalProperties":false}},"rows":{"type":"array","items":{"type":"object","properties":{"lineKey":{"type":"string","minLength":1,"maxLength":255},"orderLabel":{"type":"string","minLength":1,"maxLength":255},"invoiceLabel":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"accountName":{"type":"string","minLength":1,"maxLength":255},"farmName":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"blendName":{"type":"string","minLength":1,"maxLength":255},"quantity":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"month":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"ingredients":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"perUnit":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"forOrder":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"drawn":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false}},"required":["name","perUnit","forOrder","drawn"],"additionalProperties":false}}},"required":["lineKey","orderLabel","invoiceLabel","accountName","farmName","blendName","quantity","month","ingredients"],"additionalProperties":false}},"totals":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false}}},"required":["cards","rows","totals"],"additionalProperties":false}
stock.depotsBusiness procedure UI supported

Input

No input schema declared; no input shape inferred.

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"arrangement":{"type":"string","enum":["owned","rented","thirdParty"],"format":"enum"},"pickup":{"type":"string","enum":["enabled","shipFromOnly"],"format":"enum"},"createdAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"shippingAddress":{"anyOf":[{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false},{"type":"null"}]}},"required":["id","name","arrangement","pickup","createdAt","shippingAddress"],"additionalProperties":false}}
stock.onHandBusiness procedure Backend only

Input contains unmodeled nodes

FieldLogical typePresence
limitintegermay be omitted
cursorstring | nullmay be omitted
qstringmay be omitted
sort"product"may be omitted
compareUnmodeled: catchmay be omitted
9 schema notes
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.q runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sort runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.compare unsupported: This schema node is unmodeled. Displayed component or inner shapes are informational; no accepted value shape is inferred for the missing representation.
  • $.compare unsupported: This schema node is unmodeled. Displayed component or inner shapes are informational; no accepted value shape is inferred for the missing representation.
  • $.compare runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.compare runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":200},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"q":{"type":"string","maxLength":120},"sort":{"type":"string","const":"product"},"compare":{"x-unsupported":"catch","x-declared-inner":{"x-unsupported":"transform"}}}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
totalintegerrequired
nextCursorstring | nullrequired
facetsobjectrequired
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"productSku":{"type":"string","minLength":1,"maxLength":64},"productName":{"type":"string","minLength":1,"maxLength":255},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"warehouseName":{"type":"string","minLength":1,"maxLength":255},"onHand":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"lots":{"type":"integer","minimum":0,"maximum":9007199254740991},"nearestExpiry":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]}},"required":["catalogItemId","productSku","productName","warehouseId","warehouseName","onHand","unit","lots","nearestExpiry"],"additionalProperties":false}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"facets":{"type":"object","properties":{},"additionalProperties":false}},"required":["rows","total","nextCursor","facets"],"additionalProperties":false}
stock.productStockBusiness procedure Backend only

Input contains unmodeled nodes

FieldLogical typePresence
limitintegermay be omitted
cursorstring | nullmay be omitted
qstringmay be omitted
sort"product"may be omitted
compareUnmodeled: catchmay be omitted
9 schema notes
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.q runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sort runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.compare unsupported: This schema node is unmodeled. Displayed component or inner shapes are informational; no accepted value shape is inferred for the missing representation.
  • $.compare unsupported: This schema node is unmodeled. Displayed component or inner shapes are informational; no accepted value shape is inferred for the missing representation.
  • $.compare runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.compare runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":200},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"q":{"type":"string","maxLength":120},"sort":{"type":"string","const":"product"},"compare":{"x-unsupported":"catch","x-declared-inner":{"x-unsupported":"transform"}}}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
totalintegerrequired
nextCursorstring | nullrequired
facetsobjectrequired
columns"warehouses" | "sum"required
warehousesarray of objectrequired
depotsarray of objectrequired
todayCalendarDay | nullrequired
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"productSku":{"type":"string","minLength":1,"maxLength":64},"productName":{"type":"string","minLength":1,"maxLength":255},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"onHandByWarehouse":{"type":"array","items":{"type":"object","properties":{"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"onHand":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"Amount"},{"type":"null"}]}},"required":["warehouseId","onHand"],"additionalProperties":false}},"inboundByWarehouse":{"type":"array","items":{"type":"object","properties":{"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"inbound":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"Amount"},{"type":"null"}]}},"required":["warehouseId","inbound"],"additionalProperties":false}},"onHandSum":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"Amount"},{"type":"null"}]},"inboundSum":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"Amount"},{"type":"null"}]},"total":{"type":"string","format":"decimal","x-wire-kind":"Amount"}},"required":["catalogItemId","productSku","productName","unit","onHandByWarehouse","inboundByWarehouse","onHandSum","inboundSum","total"],"additionalProperties":false}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"facets":{"type":"object","properties":{},"additionalProperties":false},"columns":{"type":"string","enum":["warehouses","sum"]},"warehouses":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1,"maxLength":255}},"required":["key","label"],"additionalProperties":false}},"depots":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"arrangement":{"type":"string","enum":["owned","rented","thirdParty"],"format":"enum"},"pickup":{"type":"string","enum":["enabled","shipFromOnly"],"format":"enum"},"createdAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"shippingAddress":{"anyOf":[{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"],"additionalProperties":false},{"type":"null"}]},"itemCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"lotCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"inboundExpectedDates":{"type":"array","items":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]}}},"required":["id","name","arrangement","pickup","createdAt","shippingAddress","itemCount","lotCount","inboundExpectedDates"],"additionalProperties":false}},"today":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]}},"required":["rows","total","nextCursor","facets","columns","warehouses","depots","today"],"additionalProperties":false}
stock.recordOpeningBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
lotsarray of objectrequired
2 schema notes
  • $.lots[].lotNumber refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lots[].qty refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"lots":{"type":"array","items":{"type":"object","properties":{"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sku":{"type":"string","minLength":1,"maxLength":64},"lotNumber":{"type":"string","minLength":1,"maxLength":64,"format":"lot"},"qty":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"landedCost":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"expiresAt":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["warehouseId","sku","qty","landedCost"]},"minItems":1}},"required":["lots"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"layerIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["layerIds"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unknown_sku"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"warehouse_not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"blend_stocked_by_ingredients"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
stock.recordProducedBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
catalogItemIdstring (uuid)required
warehouseIdstring (uuid)required
lotNumberstring (lot)may be omitted
qtyAmountrequired
unitCostinteger (money)required
expiresAtCalendarDaymay be omitted
2 schema notes
  • $.lotNumber refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.qty refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lotNumber":{"type":"string","minLength":1,"maxLength":64,"format":"lot"},"qty":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unitCost":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"expiresAt":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["catalogItemId","warehouseId","qty","unitCost"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"layerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["layerId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"catalog_item_not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"warehouse_not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_manufactured"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
stock.reviseWarehouseBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
warehouseIdstring (uuid)required
namestringrequired
addressobjectrequired
pickup"enabled" | "shipFromOnly"required
Full logical schema
{"type":"object","properties":{"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"maxLength":255},"street2":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"city":{"type":"string","minLength":1,"maxLength":120},"state":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"]},"zip":{"type":"string","pattern":"^\\d{5}(-\\d{4})?$","format":"zip"}},"required":["street","street2","city","state","zip"]},"pickup":{"type":"string","enum":["enabled","shipFromOnly"],"format":"enum"}},"required":["warehouseId","name","address","pickup"],"additionalProperties":false}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["warehouseId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"warehouse_not_found"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
stock.supplyBoardRead inventory supply and demand. Backend only

Input shape documented

FieldLogical typePresence
matchstringmay be omitted
needsOrderingbooleanmay be omitted
3 schema notes
  • $.match runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.match runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.needsOrdering runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"match":{"type":"string"},"needsOrdering":{"type":"boolean"}}}

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"categories":{"type":"array","items":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}},"supplierNames":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"committed":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"quote":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"onHand":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"inbound":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"expectedAt":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"available":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"gap":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"status":{"type":"string","enum":["covered","risk","short"]},"demandTotal":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"supplyTotal":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"coveragePercent":{"anyOf":[{"type":"number","format":"percent"},{"type":"null"}]},"coverageDelta":{"type":"object","properties":{"kind":{"type":"string","enum":["short","spare","even"]},"value":{"type":"string","format":"decimal","x-wire-kind":"Amount"}},"required":["kind","value"],"additionalProperties":false},"caption":{"type":"string","enum":["noDemand","covered","stockCoversCommitted","afterInbound","mostlyQuotes","none","shortAfterInbound"]},"landed":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"known"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unknown"}},"required":["_tag"],"additionalProperties":false}]}},"required":["catalogItemId","sku","name","categories","supplierNames","committed","quote","onHand","inbound","expectedAt","available","gap","status","demandTotal","supplyTotal","coveragePercent","coverageDelta","caption","landed"],"additionalProperties":false}}
stock.warehouseInboundRead inbound warehouse stock. UI supported

Input shape documented

FieldLogical typePresence
warehouseIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["warehouseId"]}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
todayCalendarDayrequired
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"purchaseOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"poRef":{"type":"string","minLength":1,"maxLength":255},"supplierName":{"type":"string","minLength":1,"maxLength":255},"expectedAt":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"loadLine":{"type":"string","minLength":1,"maxLength":255}},"required":["purchaseOrderId","poRef","supplierName","expectedAt","loadLine"],"additionalProperties":false}},"today":{"type":"string","format":"date","x-wire-kind":"CalendarDay"}},"required":["rows","today"],"additionalProperties":false}
stock.warehouseLevelsRead warehouse stock levels. UI supported

Input shape documented

FieldLogical typePresence
warehouseIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["warehouseId"]}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
warehousesarray of objectrequired
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"productSku":{"type":"string","minLength":1,"maxLength":64},"productName":{"type":"string","minLength":1,"maxLength":255},"packLabel":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"onHandByWarehouse":{"type":"array","items":{"type":"object","properties":{"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"onHand":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"Amount"},{"type":"null"}]}},"required":["warehouseId","onHand"],"additionalProperties":false}},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"inboundByWarehouse":{"type":"array","items":{"type":"object","properties":{"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"inbound":{"anyOf":[{"type":"string","format":"decimal","x-wire-kind":"Amount"},{"type":"null"}]}},"required":["warehouseId","inbound"],"additionalProperties":false}},"total":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"price":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"lots":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["catalogItemId","productSku","productName","packLabel","onHandByWarehouse","unit","inboundByWarehouse","total","price","lots"],"additionalProperties":false}},"warehouses":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"label":{"type":"string","minLength":1,"maxLength":255}},"required":["key","label"],"additionalProperties":false}}},"required":["rows","warehouses"],"additionalProperties":false}
stock.warehouseLotsRead warehouse inventory lots. UI supported

Input shape documented

FieldLogical typePresence
warehouseIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["warehouseId"]}

Output shape documented

array of object

1 schema note
  • $[].lotNumber|0.number refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"array","items":{"type":"object","properties":{"layerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lotNumber":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"known"},"number":{"type":"string","minLength":1,"maxLength":64,"format":"lot"}},"required":["_tag","number"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unknown"}},"required":["_tag"],"additionalProperties":false}]},"qtyRemaining":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"lotState":{"type":"string","enum":["available","drained","overdrawn"]},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"expiresAt":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"provenance":{"type":"string","enum":["received","restock","opening","produced"]},"provenanceLabel":{"type":"string","minLength":1,"maxLength":255},"landedCost":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"known"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unknown"}},"required":["_tag"],"additionalProperties":false}]},"purchaseOrderId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"purchaseOrderRef":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"supplierName":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"productName":{"type":"string","minLength":1,"maxLength":255},"productSku":{"type":"string","minLength":1,"maxLength":64}},"required":["layerId","lotNumber","qtyRemaining","lotState","unit","expiresAt","provenance","provenanceLabel","landedCost","purchaseOrderId","purchaseOrderRef","supplierName","productName","productSku"],"additionalProperties":false}}

stockEntry

Purchase recording, receiving, and price entry

Supplier/catalog lookups, purchase recording, stock receipt, and actual-price entry fields and results.

stockEntry.catalogRead supplier catalog items for stock entry. UI supported

Input shape documented

FieldLogical typePresence
supplierIdstring (uuid)required
asOfstring (date-time)required
qstringmay be omitted
2 schema notes
  • $.asOf runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.q runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"supplierId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"asOf":{"type":"string","format":"date-time","x-zod-type":"date"},"q":{"type":"string"}},"required":["supplierId","asOf"]}

Output shape documented

array of object

3 schema notes
  • $[].increment refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $[].soldAs|0.pack.size.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $[].soldAs|1.increment refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"categories":{"type":"array","items":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]}},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]},"increment":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"soldAs":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"packaged"},"pack":{"type":"object","properties":{"count":{"type":"integer","minimum":1,"maximum":9007199254740991},"size":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false}},"required":["count","size"],"additionalProperties":false}},"required":["_tag","pack"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"measured"},"unit":{"type":"string","enum":["lb","ton","gal","L","bu","cwt","acre"]},"increment":{"type":"string","format":"decimal","x-wire-kind":"Amount"}},"required":["_tag","unit","increment"],"additionalProperties":false}]},"price":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"pricing":{"anyOf":[{"type":"object","properties":{"msrp":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},"net":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["msrp","net"],"additionalProperties":false},{"type":"null"}]},"sellable":{"type":"boolean"},"unsellableReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"stockNote":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["catalogItemId","sku","name","categories","unit","increment","soldAs","price","pricing","sellable","unsellableReason","stockNote"],"additionalProperties":false}}
stockEntry.priceBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
purchaseOrderIdstring (uuid)required
notestringrequired
linesarray of objectrequired
Full logical schema
{"type":"object","properties":{"purchaseOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"note":{"type":"string","minLength":1},"lines":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"unitCost":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"format":"money"}},"required":["catalogItemId","unitCost"]},"minItems":1}},"required":["purchaseOrderId","note","lines"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"preview":{"type":"boolean"},"purchaseOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reference":{"type":"string","minLength":1,"maxLength":255},"summary":{"type":"string"},"lines":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"notificationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["preview","purchaseOrderId","reference","summary","lines"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["future_receipt","incompatible_item","invalid_quantity","nothing_to_price","po_missing","price_recorded","duplicate_item","not_bought","catalog_item_not_found","po_cancelled","po_received","no_contact_email","recipient_not_on_account"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
stockEntry.receiveBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dateCalendarDayrequired
notestringmay be omitted
purchaseOrderIdstring (uuid)required
linesarray of objectrequired
remainder"left_open" | "closed_short"required
3 schema notes
  • $.note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[].lotNumber refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[].quantity refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"date":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"note":{"type":"string"},"purchaseOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lines":{"type":"array","items":{"type":"object","properties":{"lotNumber":{"type":"string","minLength":1,"maxLength":64,"format":"lot"},"expiresAt":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"quantity":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"cost":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"unknown"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"suggested"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","amount"]},{"type":"object","properties":{"kind":{"type":"string","const":"actual"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","amount"]}]}},"required":["catalogItemId","quantity","cost"]},"minItems":1},"remainder":{"type":"string","enum":["left_open","closed_short"]}},"required":["date","purchaseOrderId","lines","remainder"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"preview":{"type":"boolean"},"purchaseOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reference":{"type":"string","minLength":1,"maxLength":255},"summary":{"type":"string"},"lines":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"notificationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["preview","purchaseOrderId","reference","summary","lines"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["future_receipt","incompatible_item","invalid_quantity","nothing_to_price","po_missing","price_recorded","duplicate_item","not_bought","catalog_item_not_found","po_cancelled","po_received","no_contact_email","recipient_not_on_account"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
stockEntry.recordBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dateCalendarDayrequired
notestringmay be omitted
supplierIdstring (uuid)required
warehouseIdstring (uuid)required
timing"expected" | "received"required
linesarray of objectrequired
sendobjectmay be omitted
documentIdsarray of string (uuid)may be omitted
estFreightBpsintegermay be omitted
4 schema notes
  • $.note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[].lotNumber refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[].quantity refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.send.recipients[].email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"date":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"note":{"type":"string"},"supplierId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"timing":{"type":"string","enum":["expected","received"]},"lines":{"type":"array","items":{"type":"object","properties":{"lotNumber":{"type":"string","minLength":1,"maxLength":64,"format":"lot"},"expiresAt":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"quantity":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"cost":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"unknown"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"suggested"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","amount"]},{"type":"object","properties":{"kind":{"type":"string","const":"actual"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","amount"]}]}},"required":["catalogItemId","quantity","cost"]},"minItems":1},"send":{"type":"object","properties":{"recipients":{"type":"array","items":{"type":"object","properties":{"personId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"required":["personId","email"]},"minItems":1}},"required":["recipients"]},"documentIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"estFreightBps":{"type":"integer","minimum":0,"maximum":10000}},"required":["date","supplierId","warehouseId","timing","lines"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"preview":{"type":"boolean"},"purchaseOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"reference":{"type":"string","minLength":1,"maxLength":255},"summary":{"type":"string"},"lines":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"notificationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"status":{"type":"string","minLength":1,"maxLength":255}},"required":["preview","purchaseOrderId","reference","summary","lines","status"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["future_receipt","incompatible_item","invalid_quantity","nothing_to_price","po_missing","price_recorded","duplicate_item","not_bought","catalog_item_not_found","po_cancelled","po_received","no_contact_email","recipient_not_on_account"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
stockEntry.sceneBusiness procedure UI supported

Input shape documented

object | object | object | object | object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"scenario":{"type":"string","const":"product"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["scenario","catalogItemId"]},{"type":"object","properties":{"scenario":{"type":"string","const":"supplier"},"supplierId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["scenario","supplierId"]},{"type":"object","properties":{"scenario":{"type":"string","const":"demand"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["scenario"]},{"type":"object","properties":{"scenario":{"type":"string","const":"warehouse"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["scenario","warehouseId"]},{"type":"object","properties":{"scenario":{"type":"string","const":"receive"},"purchaseOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["scenario","purchaseOrderId"]},{"type":"object","properties":{"scenario":{"type":"string","const":"price"},"purchaseOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["scenario","purchaseOrderId"]}]}

Output shape documented

FieldLogical typePresence
receiptQuantitiesarray of objectrequired
contextstringrequired
todayCalendarDayrequired
priceAsOfstring (date-time)required
timing"expected" | "received"required
suppliersarray of objectrequired
warehousesarray of objectrequired
supplierIdstring (uuid) | nullrequired
warehouseIdstring (uuid) | nullrequired
initialLinesarray of objectrequired
purchaseOrderIdstring (uuid) | nullrequired
referencestring | nullrequired
2 schema notes
  • $.suppliers[].contacts[].email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.initialLines[].increment refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"receiptQuantities":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"lineNumbers":{"type":"array","items":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"ordered":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"received":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"outstanding":{"type":"string","format":"decimal","x-wire-kind":"Amount"}},"required":["catalogItemId","lineNumbers","ordered","received","outstanding"],"additionalProperties":false}},"context":{"type":"string","minLength":1,"maxLength":255},"today":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"priceAsOf":{"type":"string","format":"date-time","x-zod-type":"date"},"timing":{"type":"string","enum":["expected","received"]},"suppliers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"contacts":{"type":"array","items":{"type":"object","properties":{"personId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"email":{"anyOf":[{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"relationship":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"role":{"type":"string","enum":["primary","additional"]}},"required":["personId","name","email","relationship","role"],"additionalProperties":false}}},"required":["id","name"],"additionalProperties":false}},"warehouses":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255}},"required":["id","name"],"additionalProperties":false}},"supplierId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"warehouseId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"initialLines":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"unitPrice":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"increment":{"type":"string","format":"decimal","x-wire-kind":"Amount"}},"required":["sku","name","qty","unitPrice","catalogItemId","increment"],"additionalProperties":false}},"purchaseOrderId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]}},"required":["receiptQuantities","context","today","priceAsOf","timing","suppliers","warehouses","supplierId","warehouseId","initialLines","purchaseOrderId","reference"],"additionalProperties":false}
stockEntry.sendPreviewBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
dateCalendarDayrequired
notestringmay be omitted
supplierIdstring (uuid)required
warehouseIdstring (uuid)required
timing"expected" | "received"required
linesarray of objectrequired
sendobjectmay be omitted
documentIdsarray of string (uuid)may be omitted
estFreightBpsintegermay be omitted
4 schema notes
  • $.note runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[].lotNumber refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lines[].quantity refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.send.recipients[].email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"date":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"note":{"type":"string"},"supplierId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"warehouseId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"timing":{"type":"string","enum":["expected","received"]},"lines":{"type":"array","items":{"type":"object","properties":{"lotNumber":{"type":"string","minLength":1,"maxLength":64,"format":"lot"},"expiresAt":{"type":"string","format":"date","x-wire-kind":"CalendarDay"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"quantity":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"cost":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"unknown"}},"required":["kind"]},{"type":"object","properties":{"kind":{"type":"string","const":"suggested"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","amount"]},{"type":"object","properties":{"kind":{"type":"string","const":"actual"},"amount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["kind","amount"]}]}},"required":["catalogItemId","quantity","cost"]},"minItems":1},"send":{"type":"object","properties":{"recipients":{"type":"array","items":{"type":"object","properties":{"personId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"required":["personId","email"]},"minItems":1}},"required":["recipients"]},"documentIds":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"estFreightBps":{"type":"integer","minimum":0,"maximum":10000}},"required":["date","supplierId","warehouseId","timing","lines"]}

Output shape documented

FieldLogical typePresence
referencestring | nullrequired
vendorNamestringrequired
linesinteger (number)required
subtotalinteger (money) | nullrequired
accountIdstring (uuid) | nullrequired
recipientsarray of objectrequired
reviseContactHeldarray of string (uuid)required
refusalobject | nullrequired
subjectstring | nullrequired
htmlstringrequired
attachmentstring | nullrequired
lastSendobject | nullrequired
2 schema notes
  • $.recipients[].email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.lastSend.to[] refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"reference":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"vendorName":{"type":"string","minLength":1,"maxLength":255},"lines":{"type":"integer","minimum":0,"maximum":9007199254740991,"format":"number"},"subtotal":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"accountId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"recipients":{"type":"array","items":{"type":"object","properties":{"personId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"phone":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"addressLines":{"anyOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},{"type":"null"}]},"relationship":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"role":{"type":"string","enum":["primary","additional"]},"status":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]}},"required":["personId","name","phone","email","addressLines","relationship","role","status"],"additionalProperties":false}},"reviseContactHeld":{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"refusal":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_contact_email"}},"required":["code"],"additionalProperties":false},{"type":"null"}]},"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"html":{"type":"string","minLength":1},"attachment":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"lastSend":{"anyOf":[{"type":"object","properties":{"at":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"to":{"type":"array","items":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"status":{"type":"string","minLength":1,"maxLength":255}},"required":["at","to","status"],"additionalProperties":false},{"type":"null"}]}},"required":["reference","vendorName","lines","subtotal","accountId","recipients","reviseContactHeld","refusal","subject","html","attachment","lastSend"],"additionalProperties":false}

supplier

Suppliers and incoming orders

Supplier records, catalog connections and shares, incoming orders, and purchase-term fields.

supplier.acceptIncomingOrderBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
saleOrderIdstring (uuid)required
destinationLocationIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"destinationLocationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["saleOrderId","destinationLocationId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"purchaseOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"poNumber":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["purchaseOrderId","poNumber"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_connected"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"already_accepted"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_bought"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"catalog_item_not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unpriced_line"},"skus":{"type":"array","items":{"type":"string","minLength":1,"maxLength":64}}},"required":["code","skus"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_carried"},"sku":{"type":"string","minLength":1,"maxLength":64}},"required":["code","sku"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
supplier.addBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
kindobject | objectrequired
namestringrequired
contactobjectrequired
4 schema notes
  • $ refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contact|0.contactFirstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contact|0.contactLastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contact|0.contactEmail refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"kind":{"oneOf":[{"type":"object","properties":{"value":{"type":"string","const":"manufacturer"}},"required":["value"]},{"type":"object","properties":{"value":{"type":"string","const":"distributor"}},"required":["value"]}]},"name":{"type":"string","minLength":1,"maxLength":255},"contact":{"oneOf":[{"type":"object","properties":{"contactFirstName":{"type":"string","minLength":1,"maxLength":100},"contactLastName":{"type":"string","minLength":1,"maxLength":100},"contactPhone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"contactEmail":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"mode":{"type":"string","const":"new"}},"required":["contactFirstName","contactLastName","mode"]}]}},"required":["kind","name","contact"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"supplierCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["accountId","supplierCompanyId","connectionId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["no_company","duplicate_company","duplicate_person"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
supplier.addItemBusiness procedure UI supported

Input contains unmodeled nodes

Unmodeled: intersection

7 schema notes
  • $ unsupported: This schema node is unmodeled. Displayed component or inner shapes are informational; no accepted value shape is inferred for the missing representation.
  • $&0|0.soldAs|0.pack.value refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $&0|0.soldAs|1.increment refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $&0|0.soldAs|1.increment runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $&0|1.soldAs|0.pack.value refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $&0|1.soldAs|1.increment refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $&0|1.soldAs|1.increment runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"x-unsupported":"intersection","x-declared-components":[{"oneOf":[{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"soldAs":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"packaged"},"pack":{"type":"object","properties":{"count":{"type":"integer","minimum":1,"maximum":9007199254740991},"value":{"type":"number","exclusiveMinimum":0},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["count","value","unit"]}},"required":["_tag","pack"]},{"type":"object","properties":{"_tag":{"type":"string","const":"measured"},"unit":{"type":"string","enum":["lb","ton","gal","L","bu","cwt","acre"]},"increment":{"type":"number","exclusiveMinimum":0,"exclusiveMaximum":100000000000000}},"required":["_tag","unit"]}]},"price":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"format":"money"},"supplied":{"type":"boolean"},"kind":{"type":"string","const":"existing"},"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["sku","soldAs","price","kind","productId"]},{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"soldAs":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"packaged"},"pack":{"type":"object","properties":{"count":{"type":"integer","minimum":1,"maximum":9007199254740991},"value":{"type":"number","exclusiveMinimum":0},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["count","value","unit"]}},"required":["_tag","pack"]},{"type":"object","properties":{"_tag":{"type":"string","const":"measured"},"unit":{"type":"string","enum":["lb","ton","gal","L","bu","cwt","acre"]},"increment":{"type":"number","exclusiveMinimum":0,"exclusiveMaximum":100000000000000}},"required":["_tag","unit"]}]},"price":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"format":"money"},"supplied":{"type":"boolean"},"kind":{"type":"string","const":"compass"},"compassUid":{"type":"string","minLength":1}},"required":["sku","soldAs","price","kind","compassUid"]}]},{"type":"object","properties":{"supplierCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["supplierCompanyId"]}]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"listPriceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["catalogItemId","productId","listPriceId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unknown_product"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"unknown_compass_product"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"already_carried"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"sku_taken"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"sku_unit_mismatch"}},"required":["code"],"additionalProperties":false}]}]},{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["no_company","connection_not_found","catalog_item_not_found","not_bought"]}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
supplier.addOwnItemBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
namestringrequired
category"herbicide" | "insecticide" | "fungicide" | "nematicide" | "miticide" | "fumigant" | "biopesticide" | "pgr" | "defoliant" | "desiccant" | "repellent" | "insect_growth_regulator" | "seed_treatment" | "seed_lubricant" | "seed" | "fertilizer" | "micronutrient" | "nutritional" | "manure" | "nitrogen_stabilizer" | "manure_treatment" | "biological" | "inoculant" | "biostimulant" | "adjuvant" | "tank_cleaner" | "equipment" | "service" | "other"required
manufacturerstringmay be omitted
brandstringmay be omitted
skustringrequired
soldAsobject | objectrequired
priceinteger (money)required
suppliedbooleanmay be omitted
supplierCompanyIdstring (uuid)required
3 schema notes
  • $.soldAs|0.pack.value refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.soldAs|1.increment refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.soldAs|1.increment runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"category":{"type":"string","enum":["herbicide","insecticide","fungicide","nematicide","miticide","fumigant","biopesticide","pgr","defoliant","desiccant","repellent","insect_growth_regulator","seed_treatment","seed_lubricant","seed","fertilizer","micronutrient","nutritional","manure","nitrogen_stabilizer","manure_treatment","biological","inoculant","biostimulant","adjuvant","tank_cleaner","equipment","service","other"]},"manufacturer":{"type":"string","minLength":1,"maxLength":255},"brand":{"type":"string","minLength":1,"maxLength":255},"sku":{"type":"string","minLength":1,"maxLength":64},"soldAs":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"packaged"},"pack":{"type":"object","properties":{"count":{"type":"integer","minimum":1,"maximum":9007199254740991},"value":{"type":"number","exclusiveMinimum":0},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["count","value","unit"]}},"required":["_tag","pack"]},{"type":"object","properties":{"_tag":{"type":"string","const":"measured"},"unit":{"type":"string","enum":["lb","ton","gal","L","bu","cwt","acre"]},"increment":{"type":"number","exclusiveMinimum":0,"exclusiveMaximum":100000000000000}},"required":["_tag","unit"]}]},"price":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"format":"money"},"supplied":{"type":"boolean"},"supplierCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["name","category","sku","soldAs","price","supplierCompanyId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"listPriceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["catalogItemId","listPriceId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"shadows_compass_product"},"compassUid":{"type":"string","minLength":1}},"required":["code","compassUid"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"sku_taken"}},"required":["code"],"additionalProperties":false}]}]},{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["no_company","connection_not_found","catalog_item_not_found","not_bought"]}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
supplier.availableSharesBusiness procedure UI supported

Input

No input schema declared; no input shape inferred.

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"supplierCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"surface":{"type":"string","enum":["catalog"]},"surfaceLabel":{"type":"string","minLength":1,"maxLength":255}},"required":["supplierCompanyId","name","surface","surfaceLabel"],"additionalProperties":false}}
supplier.byIdBusiness procedure UI supported

Input shape documented

object | object

Full logical schema
{"anyOf":[{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["connectionId"]},{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["accountId"]}]}

Output shape documented

FieldLogical typePresence
accountIdstring (uuid)required
connectionIdstring (uuid)required
supplierCompanyIdstring (uuid)required
namestringrequired
kindstringmay be omitted
primaryContactNamestringmay be omitted
emailstring (email)may be omitted
phonestring (phone)may be omitted
statusstringrequired
termsNetDaysinteger | nullrequired
termsLabelstring | nullrequired
skusSuppliedintegerrequired
ytdSpendinteger (money) | nullrequired
sinceCalendarDay | nullrequired
skusarray of objectrequired
priceSheetarray of objectrequired
totalsobjectrequired
addProductobject | objectrequired
state"managed" | "connected" | "disconnected"required
counterpartySharedbooleanrequired
fulfilledBy"own" | "supplier"required
ownCompanyNamestringrequired
3 schema notes
  • $.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.priceSheet[].soldAs|0.pack.size.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.priceSheet[].soldAs|1.increment refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"supplierCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","minLength":1,"maxLength":255},"primaryContactName":{"type":"string","minLength":1,"maxLength":255},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"status":{"type":"string","minLength":1,"maxLength":255},"termsNetDays":{"anyOf":[{"type":"integer","minimum":0,"maximum":365},{"type":"null"}]},"termsLabel":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"skusSupplied":{"type":"integer","minimum":0,"maximum":9007199254740991},"ytdSpend":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"since":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]},"skus":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"productName":{"type":"string","minLength":1,"maxLength":255},"sku":{"type":"string","minLength":1,"maxLength":64},"skuLabel":{"type":"string","minLength":1,"maxLength":255},"supplyOffered":{"type":"boolean"},"unitCost":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"listCost":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"msrp":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"margin":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"known"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"sale_price_missing"}},"required":["_tag"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"cost_missing"}},"required":["_tag"],"additionalProperties":false}]},"marginStatus":{"type":"string","enum":["ok","below_cost","unknown"]},"marginPercent":{"anyOf":[{"type":"number","format":"percent"},{"type":"null"}]},"inboundQty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false}},"required":["catalogItemId","productId","productName","sku","skuLabel","supplyOffered","unitCost","listCost","msrp","margin","marginStatus","marginPercent","inboundQty"],"additionalProperties":false}},"priceSheet":{"type":"array","items":{"type":"object","properties":{"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"productName":{"type":"string","minLength":1,"maxLength":255},"sku":{"type":"string","minLength":1,"maxLength":64},"unitCost":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"soldAs":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"packaged"},"pack":{"type":"object","properties":{"count":{"type":"integer","minimum":1,"maximum":9007199254740991},"size":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false}},"required":["count","size"],"additionalProperties":false}},"required":["_tag","pack"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"measured"},"unit":{"type":"string","enum":["lb","ton","gal","L","bu","cwt","acre"]},"increment":{"type":"string","format":"decimal","x-wire-kind":"Amount"}},"required":["_tag","unit","increment"],"additionalProperties":false}]},"carrying":{"type":"string","enum":["carrying","notCarrying"]},"myPrice":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"addProduct":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"blocked"},"error":{"type":"string","enum":["already_carried","sku_unit_mismatch"]}},"required":["status","error"],"additionalProperties":false}]}},"required":["catalogItemId","productId","productName","sku","unitCost","soldAs","carrying","myPrice","addProduct"],"additionalProperties":false}},"totals":{"type":"object","properties":{"itemCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"belowCostCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"missingCostCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"medianMarginPercent":{"anyOf":[{"type":"number","format":"percent"},{"type":"null"}]},"inboundTotal":{"anyOf":[{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},{"type":"null"}]}},"required":["itemCount","belowCostCount","missingCostCount","medianMarginPercent","inboundTotal"],"additionalProperties":false},"addProduct":{"oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"ready"}},"required":["status"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"forbidden"}},"required":["status"],"additionalProperties":false}]},"state":{"type":"string","enum":["managed","connected","disconnected"]},"counterpartyShared":{"type":"boolean"},"fulfilledBy":{"type":"string","enum":["own","supplier"]},"ownCompanyName":{"type":"string","minLength":1,"maxLength":255}},"required":["accountId","connectionId","supplierCompanyId","name","status","termsNetDays","termsLabel","skusSupplied","ytdSpend","since","skus","priceSheet","totals","addProduct","state","counterpartyShared","fulfilledBy","ownCompanyName"],"additionalProperties":false}
supplier.connectBusiness procedure Backend only

Input shape documented

FieldLogical typePresence
connectionIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["connectionId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["connectionId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"connection_not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_managed"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_share"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
supplier.connectFromAvailableBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
sellerCompanyIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"sellerCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["sellerCompanyId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["connectionId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"no_company"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_managed"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_share"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_sender"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
supplier.connectionsBusiness procedure UI supported

Input

No input schema declared; no input shape inferred.

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","enum":["inbound","pending","connected","disconnected"]},"label":{"type":"string","minLength":1,"maxLength":255},"counterparty":{"type":"string","minLength":1,"maxLength":255},"surfaceLabel":{"type":"string","minLength":1,"maxLength":255},"target":{"oneOf":[{"type":"object","properties":{"job":{"type":"string","const":"request"},"sellerCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["job","sellerCompanyId"],"additionalProperties":false},{"type":"object","properties":{"job":{"type":"string","const":"edge"},"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["job","connectionId"],"additionalProperties":false},{"type":"object","properties":{"job":{"type":"string","const":"share"},"buyerCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["job","buyerCompanyId"],"additionalProperties":false}]},"edgeTag":{"anyOf":[{"type":"string","enum":["managed","connected","disconnected"]},{"type":"null"}]},"counterpartyShared":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"held":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}}},"required":["key","kind","label","counterparty","surfaceLabel","target","edgeTag","counterpartyShared","held"],"additionalProperties":false}}
supplier.dedupBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
opNamestringmay be omitted
contactNamestringmay be omitted
phonestring (phone)may be omitted
emailstring (email)may be omitted
side"buy"required
3 schema notes
  • $.opName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.contactName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"opName":{"type":"string","minLength":2},"contactName":{"type":"string","minLength":2},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"side":{"type":"string","const":"buy"}},"required":["side"]}

Output shape documented

FieldLogical typePresence
resolutionobject | objectrequired
duplicate"company" | "person" | "both" | nullrequired
4 schema notes
  • $.resolution|1.accounts[].subject|2.compassCompanyUid runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.resolution|1.contacts[].person.firstName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.resolution|1.contacts[].person.lastName refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.resolution|1.contacts[].person.email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"resolution":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"clear"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"matches"},"accounts":{"type":"array","items":{"type":"object","properties":{"_tag":{"type":"string","enum":["ok","restricted"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contact":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"person"},"personId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","personId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"none"}},"required":["kind"],"additionalProperties":false}]},"subject":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"farm"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"company"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","companyId"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"manufacturer"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"compassCompanyUid":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]}},"required":["kind","companyId","compassCompanyUid"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"distributor"},"companyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["kind","companyId"],"additionalProperties":false}]},"name":{"type":"string","minLength":1,"maxLength":255},"pursuit":{"type":"string","enum":["none","prospect","working"],"format":"enum"},"patronSince":{"type":"integer","minimum":1850,"maximum":2100}},"required":["_tag","id","ownerId","contact","subject","name","pursuit"],"additionalProperties":false}},"contacts":{"type":"array","items":{"type":"object","properties":{"person":{"type":"object","properties":{"_tag":{"type":"string","enum":["unverified","verified"]},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"billingAddressId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["_tag","id","ownerId","firstName","lastName"],"additionalProperties":false},"ownership":{"type":"string","enum":["mine","other"]}},"required":["person","ownership"],"additionalProperties":false}}},"required":["kind","accounts","contacts"],"additionalProperties":false}]},"duplicate":{"anyOf":[{"type":"string","enum":["company","person","both"]},{"type":"null"}]}},"required":["resolution","duplicate"],"additionalProperties":false}
supplier.disconnectBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
connectionIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["connectionId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["connectionId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"connection_not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_connected"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
supplier.inboundRequestCountBusiness procedure UI supported

Input

No input schema declared; no input shape inferred.

Output shape documented

integer

Full logical schema
{"type":"integer","minimum":0,"maximum":9007199254740991}
supplier.incomingOrdersBusiness procedure UI supported

Input

No input schema declared; no input shape inferred.

Output shape documented

array of object

1 schema note
  • $[].lines[].qty.amount refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"array","items":{"type":"object","properties":{"saleOrderId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sellerCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"sellerName":{"type":"string","minLength":1,"maxLength":255},"confirmedAt":{"type":"string","format":"date-time","x-wire-kind":"Instant"},"lines":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","minLength":1,"maxLength":64},"name":{"type":"string","minLength":1,"maxLength":255},"qty":{"type":"object","properties":{"amount":{"type":"string","format":"decimal","x-wire-kind":"Amount"},"unit":{"type":"string","enum":["ea","bag","lb","ton","gal","L","bu","cwt","acre"]}},"required":["amount","unit"],"additionalProperties":false},"price":{"oneOf":[{"type":"object","properties":{"_tag":{"type":"string","const":"firm"},"cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"}},"required":["_tag","cents"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","const":"unpriced"}},"required":["_tag"],"additionalProperties":false}]}},"required":["sku","name","qty","price"],"additionalProperties":false}}},"required":["saleOrderId","sellerCompanyId","sellerName","confirmedAt","lines"],"additionalProperties":false}}
supplier.listBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
limitintegermay be omitted
cursorstring | nullmay be omitted
qstringmay be omitted
sort"name"may be omitted
6 schema notes
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.limit runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.cursor runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.q runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.q runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
  • $.sort runtime: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":200},"cursor":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},"q":{"type":"string"},"sort":{"type":"string","const":"name"}}}

Output shape documented

FieldLogical typePresence
rowsarray of objectrequired
totalintegerrequired
nextCursorstring | nullrequired
facetsobjectrequired
1 schema note
  • $.rows[].email refinement: Runtime refinements, defaults, transformations and coercion are not executed by this documentation; application validation remains authoritative.
Full logical schema
{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"supplierCompanyId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255},"kind":{"type":"string","minLength":1,"maxLength":255},"primaryContactName":{"type":"string","minLength":1,"maxLength":255},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"phone":{"type":"string","pattern":"^\\+\\d{7,15}$","format":"phone"},"status":{"type":"string","minLength":1,"maxLength":255},"termsNetDays":{"anyOf":[{"type":"integer","minimum":0,"maximum":365},{"type":"null"}]},"termsLabel":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}]},"skusSupplied":{"type":"integer","minimum":0,"maximum":9007199254740991},"ytdSpend":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"format":"money"},{"type":"null"}]},"since":{"anyOf":[{"type":"string","format":"date","x-wire-kind":"CalendarDay"},{"type":"null"}]}},"required":["accountId","connectionId","supplierCompanyId","name","status","termsNetDays","termsLabel","skusSupplied","ytdSpend","since"],"additionalProperties":false}},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextCursor":{"anyOf":[{"type":"string"},{"type":"null"}]},"facets":{"type":"object","properties":{},"additionalProperties":false}},"required":["rows","total","nextCursor","facets"],"additionalProperties":false}
supplier.reconnectBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
connectionIdstring (uuid)required
Full logical schema
{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["connectionId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["connectionId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"oneOf":[{"type":"object","properties":{"code":{"type":"string","const":"connection_not_found"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"not_disconnected"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","const":"no_share"}},"required":["code"],"additionalProperties":false}]}]}},"required":["ok","error"],"additionalProperties":false}]}
supplier.recordListPriceBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
connectionIdstring (uuid)required
catalogItemIdstring (uuid)required
priceinteger (money) | nullmay be omitted
Full logical schema
{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"catalogItemId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"price":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"format":"money"},{"type":"null"}]}},"required":["connectionId","catalogItemId"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"listPriceId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["listPriceId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["no_company","connection_not_found","catalog_item_not_found","not_bought"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
supplier.recordTermsBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
connectionIdstring (uuid)required
netDaysintegerrequired
Full logical schema
{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"netDays":{"type":"integer","minimum":0,"maximum":365}},"required":["connectionId","netDays"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"factId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["factId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["no_company","connection_not_found"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}
supplier.setFulfilledByBusiness procedure UI supported

Input shape documented

FieldLogical typePresence
connectionIdstring (uuid)required
fulfilledBy"own" | "supplier"required
Full logical schema
{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"fulfilledBy":{"type":"string","enum":["own","supplier"]}},"required":["connectionId","fulfilledBy"]}

Output shape documented

object | object

Full logical schema
{"oneOf":[{"type":"object","properties":{"ok":{"type":"boolean","const":true},"value":{"type":"object","properties":{"factId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["factId"],"additionalProperties":false}},"required":["ok","value"],"additionalProperties":false},{"type":"object","properties":{"ok":{"type":"boolean","const":false},"error":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","enum":["forbidden","not_a_member"]},"resource":{"type":"string"},"need":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","enum":["no_company","connection_not_found"]}},"required":["code"],"additionalProperties":false}]}},"required":["ok","error"],"additionalProperties":false}]}

user

User directory

User-list result fields used by business screens.

user.listBusiness procedure UI supported

Input

No input schema declared; no input shape inferred.

Output shape documented

array of object

Full logical schema
{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string","minLength":1,"maxLength":255}},"required":["id","name"],"additionalProperties":false}}