AlmondTill/G3N API

On this page

createRtv

mutation · in the family Purchasing

What it does

Create a new return-to-vendor — goods going back to a supplier at your organization.

CREATE an Rtv: ONE ACTIVE OrgVendor (the parent — lean 2; PO-less overstock/recall returns are legal); the optional PO must be SAME-vendor + past-issue; the ship-from LF ACTIVE + the buying org's; per line the (variant × ship-from LF) InventoryItem junction must EXIST + be active (TR-f — an RTV of a variant never stocked at the LF is meaningless) and the expectedCredit currency must match the vendor purchasingCurrency when both exist.

Who may call it

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

Arguments

NameTypeRequiredNotes
inputCreateRtvInput CreateRtvInput!yesNo further notes.

Returns

Rtv Rtv! — A return-to-vendor: goods ship BACK to an enabled vendor for credit. Parent = the OrgVendor. Lifecycle: draft compose (wholesale edits) - approve (authority:approve_rtv, a REAL maker/checker step from birth) - ship fires the FIRST rtv movements (sourceBucket relief at CURRENT WMA, lean 6 — the sell/ symmetry; present stock only, CONFLICT/INSUFFICIENT_STOCK else; resolvedReturnsContactId + the expectedCredit default stamp here) - record_credit closes it (actual!= expected refuses CONFLICT/CREDIT_MISMATCH retryable; acknowledgeVariance is the explicit cure — the variance stays reports-only, no AR/AP). Lines are EMBEDDED (max 24 — the 3N+1<=100 ship ceiling held, -m), each shipping from on_hand / damaged / held (the -mutable trio); cancel is pre-ship ONLY; credited is the immutable NON-doomed close; cancelled is the ONE doomed terminal (lists filter it).

Example request

mutation ExampleCreateRtv($input: CreateRtvInput!) {
  createRtv(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    organizationId
    purchaseOrderId
    shipFromLogicalFacilityId
    creditVarianceAcknowledged
    resolvedReturnsContactId
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "orgVendorId": "01900000-0000-7000-8000-f885fa720000",
    "shipFromLogicalFacilityId": "01900000-0000-7000-8000-edd14c5a0000",
    "lines": [
      {
        "variantId": "01900000-0000-7000-8000-8415e73b0000",
        "quantity": "2",
        "reason": "defective",
        "sourceBucket": "on_hand"
      }
    ]
  }
}

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

Example response

{
  "data": {
    "createRtv": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "RV-EXMP-0000-000F",
      "type": "Rtv",
      "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",
      "organizationId": "01900000-0000-7000-8000-44b781470000",
      "purchaseOrderId": "01900000-0000-7000-8000-54a5b8570000",
      "shipFromLogicalFacilityId": "01900000-0000-7000-8000-edd14c5a0000",
      "creditVarianceAcknowledged": true,
      "resolvedReturnsContactId": "01900000-0000-7000-8000-6fed6ee50000"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

Used in