AlmondTill/G3N API

On this page

approvePurchaseOrder

mutation · in the family Document approvals

What it does

Approve a purchase order internally so it can be submitted.

APPROVE a pending PurchaseOrder (pending_approval -> issued, authority:approve_po): an unreachable-state step until builds the spend-threshold policy (nothing can reach pending_approval); declared for the day it does. Requires the doc CURRENT revision (OCC) + the unrestricted capability.

What happens

Approval issues the order: each line’s quantity is written to stock as on order at its receiving location. A large order walks: the status reads issuing until every line has landed; re-run the same verb to resume a stalled walk.

Who may call it

Capability area: Document approvals — Approving or rejecting purchase orders and returns to vendors.

Arguments

NameTypeRequiredNotes
idID ID!yesThe id of the record.
revisionID ID!yesThe revision id you read on the record; the change is refused if an edit landed in the meantime.
reasonStringnoNo further notes.

Returns

PurchaseOrder PurchaseOrder! — A purchase order: an org orders variants x quantities x receiving LFs from ONE enabled vendor (the OrgVendor enablement — IMMUTABLE at birth). Lines live in their OWN rows since and stay draft-editable wholesale (max 1000 — the NAMED assignment ceiling, raised from 48 with the rows; at most 90 line actions per CALL, so a big order grows through addPurchaseOrderLines; the same variant to N LFs = N lines,889); currency is the OrgVendor purchasingCurrency SNAPSHOT (every Money on the family matches it — NO FX, lean 5); received/closed_short are IMMUTABLE non-doomed history; cancelled is the ONE doomed terminal (lists filter it). Re-running the same verb RESUMES a stalled walk; on a healthy in-flight order it refuses CONFLICT/IN_PROGRESS naming the progress.

Example request

mutation ExampleApprovePurchaseOrder($id: ID!, $revision: ID!, $reason: String) {
  approvePurchaseOrder(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    orgVendorId
    currency
    paymentTerms
    incotermCode
    vendorReference
    notes
    lineCount
    openLineCount
    nextLineNo
    receivingReceiptId
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "reason": "Correcting a miscount."
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "approvePurchaseOrder": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "PO-EXMP-0000-000F",
      "type": "PurchaseOrder",
      "caption": "Blue jeans",
      "status": "draft",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "orgVendorId": "01900000-0000-7000-8000-f885fa720000",
      "currency": "USD",
      "paymentTerms": "<payment terms>",
      "incotermCode": "BJ-001",
      "vendorReference": "<vendor reference>",
      "notes": "Restock before the weekend.",
      "lineCount": 1,
      "openLineCount": 1,
      "nextLineNo": 1,
      "receivingReceiptId": "01900000-0000-7000-8000-e3994aee0000"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

Used in