AlmondTill/G3N API

On this page

addPurchaseOrderLines

mutation · in the family Purchasing

What it does

Add more lines to a purchase order you have not sent yet — the way a big order gets built up.

APPEND lines to a DRAFT PurchaseOrder: the same per-line gates as create (the variant tenant-scoped + ACTIVE + stocked, the receiving LF ACTIVE + owned by the BUYING org, the unit cost in the PO currency, requireCatalogItem ⇒ a LIVE OVI, quantity ≥ the OVI moq); the DISTINCT variant × receiving-LF law holds over the WHOLE document (a key already on the order refuses VALIDATION/INVALID naming the holding lineNo); lineNo mints from the monotonic nextLineNo; the document total refuses past the ceiling. ONE transaction — the row Puts + the header rollups. A live post-draft doc refuses CONFLICT/REF_STATE. Requires the doc CURRENT revision (OCC) + the unrestricted capability. NO reason — the edit class.

What happens

Each new line takes the next line number on the order; a number already used is never handed out again, so receipts and vendor bills keep pointing at the same line forever.

Careful

Only while the order is still a draft. The same product going to the same receiving location can appear once — raise that line’s quantity instead of adding a second one.

Who may call it

Capability area: Purchasing — Purchase orders, returns to vendors, vendor invoices and supplier records.

Arguments

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

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 ExampleAddPurchaseOrderLines($input: AddPurchaseOrderLinesInput!, $revision: ID!) {
  addPurchaseOrderLines(input: $input, revision: $revision) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    orgVendorId
    currency
    paymentTerms
    incotermCode
    vendorReference
    notes
    lineCount
    openLineCount
    nextLineNo
    receivingReceiptId
  }
}

Variables:

{
  "input": {
    "purchaseOrderId": "01900000-0000-7000-8000-54a5b8570000",
    "lines": [
      {
        "variantId": "01900000-0000-7000-8000-8415e73b0000",
        "logicalFacilityId": "01900000-0000-7000-8000-8026f71c0000"
      }
    ]
  },
  "revision": "01900000-0000-7000-8000-b7960e180000"
}

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

Example response

{
  "data": {
    "addPurchaseOrderLines": {
      "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