updateRtv

mutation · in the family Supplier return

What it does

Edit a return-to-vendor — goods going back to a supplier — change its details.

Edit a Rtv's mutable attributes. Requires the unrestricted capability + the record's CURRENT revision.

Careful

Edits take effect immediately and write a new revision; the old revision stays in history.

Who may call it

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

Owner
Manager
Associate Manager
An API key whose scope allows api:updateRtv

Arguments

Name	Type	Required	Notes
`id`	ID `ID!`	yes	The id of the record.
`revision`	ID `ID!`	yes	The revision id you read on the record; the change is refused if an edit landed in the meantime.
`input`	EditRtvInput `EditRtvInput!`	yes	No 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 ExampleUpdateRtv($id: ID!, $revision: ID!, $input: EditRtvInput!) {
  updateRtv(id: $id, revision: $revision, input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    organizationId
    purchaseOrderId
    shipFromLogicalFacilityId
    creditVarianceAcknowledged
    resolvedReturnsContactId
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "input": {
    "caption": "Blue jeans"
  }
}

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

Example response

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

VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
AUTHN/REQUIRED — Sign in to do this. (AUTHN)
AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)
NOT_FOUND/* — That record could not be found. (NOT_FOUND)
CONFLICT/* — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)
VALIDATION/VERSION_REQUIRED — The request did not say which app version it came from. (VALIDATION)

Dry run

Add dryRun: true to the request envelope (extensions.at) to rehearse this call: every check runs, the write is rehearsed against the current records and nothing is stored; the answer is the refusal a real call would give, or the record it would create. Every response to a rehearsal carries dryRun: true, so a rehearsed record is never mistaken for a saved one.