# posReturn

mutation · in the family [Register approvals](/reference/register-approvals/)

## What it does

A with-receipt return at the till, in ONE step — approve, take the goods back, and refund cash from the drawer.

The POS-with-receipt return collapse: ONE call walks requested→approved→received→refunded with the cash refund REACHING the drawer. The return.approve gate evaluates UP FRONT — a below-pass tier refuses AUTHZ/APPROVAL_REQUIRED and uses the op-by-op walk (the approval fingerprint needs a pre-existing target). Realized as the op-by-op steps composed — each transaction atomic; a mid-walk failure PARKS the Return at a resumable state (posReturnParked in the error detail names it). Requires the unrestricted capability.

## What happens

Walks the whole return (approve → receive → refund) as one call; the cash refund reaches the drawer’s totals.

## Careful

Money leaves the drawer and stock comes back — both permanent, both audited. Approval tiers may require a manager above your limit.

## Who may call it

Capability area: **Register approvals** — Approving or denying the requests raised at a register.

- Owner
- Manager
- Associate Manager
- An API key whose scope allows `api:posReturn`

## Arguments

| Name | Type | Required | Notes |
| --- | --- | --- | --- |
| `input` | [PosReturnInput](/types/PosReturnInput/) `PosReturnInput!` | yes | No further notes. |

## Returns

[Return](/types/Return/) `Return!` — A sales Return / RMA — the customer→merchant goods-back document (distinct from vendor RTV; the disjoint law: a billing correction is a CreditNote/DebitNote, never a Return). References the original Order (+ optionally one of its Invoices); returns WHOLE units of order lines; receive posts per-line disposition legs at the RECEIVING LF and stamps the telescoping refund money; refund RECORDS the routing (tender mechanics; store-credit issuance).

## Example request

```graphql
mutation ExamplePosReturn($input: PosReturnInput!) {
  posReturn(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    orderId
    invoiceId
    organizationId
    currency
    refundTotalMinor
  }
}
```

Variables:

```json
{
  "input": {
    "caption": "Blue jeans",
    "orderId": "01900000-0000-7000-8000-f6d8263a0000",
    "logicalFacilityId": "01900000-0000-7000-8000-8026f71c0000",
    "lines": [
      {
        "orderLineNo": 1,
        "quantity": "2",
        "reason": "Correcting a miscount."
      }
    ],
    "dispositions": [
      {
        "lineNo": 1,
        "disposition": "restock",
        "quantity": "2",
        "reason": "Correcting a miscount."
      }
    ],
    "refund": {
      "method": "original_tender",
      "reference": "<reference>"
    }
  }
}
```

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

## Example response

```json
{
  "data": {
    "posReturn": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "RT-EXMP-0000-000F",
      "type": "Return",
      "caption": "Blue jeans",
      "status": "requested",
      "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",
      "orderId": "01900000-0000-7000-8000-f6d8263a0000",
      "invoiceId": "01900000-0000-7000-8000-504ef4ed0000",
      "organizationId": "01900000-0000-7000-8000-44b781470000",
      "currency": "USD",
      "refundTotalMinor": 1
    }
  },
  "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](/errors/VALIDATION/))
- `AUTHN/REQUIRED` — Sign in to do this. ([AUTHN](/errors/AUTHN/))
- `AUTHZ/FORBIDDEN` — Your role does not allow this action. ([AUTHZ](/errors/AUTHZ/))
- `RATE_LIMIT/THROTTLED` — Too many requests in a short time. ([RATE_LIMIT](/errors/RATE_LIMIT/))
- `NOT_FOUND/*` — That record could not be found. ([NOT_FOUND](/errors/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](/errors/CONFLICT/))
- `VALIDATION/VERSION_REQUIRED` — The request did not say which app version it came from. ([VALIDATION](/errors/VALIDATION/))

## Used in

- [Take a return and refund it](/use-cases/take-a-return/)