@sixtyninecommerce/admin 0.11.0 → 0.13.0

package/dist/purchasing/receipts.js

@@ -0,0 +1,287 @@
+import { pageFromVendureList, readOffsetCursor, } from '@sixtyninecommerce/core';
+export const GOODS_RECEIPT_LINE_FIELDS = /* GraphQL */ `
+  id
+  goodsReceiptId
+  purchaseOrderId
+  purchaseOrderCode
+  purchaseOrderLineId
+  reversesLineId
+  productVariantId
+  sku
+  name
+  supplierSku
+  purchaseUnitLabel
+  purchaseUnitFactor
+  acceptedBaseQuantity
+  rejectedBaseQuantity
+  rejectReason
+  overReceiptReason
+  cancelledBaseQuantity
+  reversedBaseQuantity
+  returnedBaseQuantity
+  returnedRejectedBaseQuantity
+  supplierCurrencyCode
+  unitCostSupplierCurrency
+  fxRate
+  fxRateSource
+  fxRateDate
+  unitCostEntityCurrency
+  landedUnitCost
+  traceability { lot expiresOn serials }
+  stockMovementId
+  externalLineId
+  createdAt
+`;
+export const GOODS_RECEIPT_FIELDS = /* GraphQL */ `
+  id
+  scopeId
+  legalEntityId
+  originChannelId
+  code
+  kind
+  reversesReceiptId
+  reversesReceiptCode
+  supplierId
+  supplier { id code name status }
+  stockLocationId
+  stockLocation { id name }
+  receivedOn
+  receivedAt
+  currencyCode
+  supplierDeliveryRef
+  reason
+  managedBy
+  externalId
+  externalNumber
+  actorRef
+  createdByRef
+  reversals { id code createdAt }
+  lines { ${GOODS_RECEIPT_LINE_FIELDS} }
+  createdAt
+`;
+export const LANDED_CHARGE_FIELDS = /* GraphQL */ `
+  id
+  goodsReceiptId
+  purchaseOrderId
+  kind
+  label
+  payeeSupplierId
+  payeeSupplier { id code name status }
+  payeeName
+  currencyCode
+  amount
+  allocation
+  incurredOn
+  fxRate
+  fxRateSource
+  fxRateDate
+  amountEntityCurrency
+  allocations { goodsReceiptLineId productVariantId baseQuantity basis amount unitCostDelta }
+  appliedAt
+  removedAt
+  removeReason
+  removedByRef
+  createdByRef
+  createdAt
+`;
+/** A receipt with its landed charges: `get` and the charge writes. */
+export const GOODS_RECEIPT_DETAIL_FIELDS = /* GraphQL */ `
+  ${GOODS_RECEIPT_FIELDS}
+  charges { ${LANDED_CHARGE_FIELDS} }
+`;
+export const RECEIVABLE_LINE_FIELDS = /* GraphQL */ `
+  purchaseOrderId
+  purchaseOrderCode
+  purchaseOrderLineId
+  position
+  supplierId
+  supplier { id code name status }
+  stockLocationId
+  productVariantId
+  sku
+  name
+  supplierSku
+  supplierBarcode
+  gtin
+  purchaseUnitLabel
+  purchaseUnitFactor
+  orderedBaseQuantity
+  cancelledBaseQuantity
+  receivedBaseQuantity
+  returnedForReplacementBaseQuantity
+  remainingBaseQuantity
+  toleranceBaseQuantity
+  maxAcceptedBaseQuantity
+  confirmedBaseQuantity
+  expectedOn
+`;
+export const GOODS_RECEIPTS_QUERY = /* GraphQL */ `
+  query GoodsReceipts($options: GoodsReceiptListOptions) {
+    goodsReceipts(options: $options) {
+      items { ${GOODS_RECEIPT_FIELDS} }
+      totalItems
+    }
+  }
+`;
+export const GOODS_RECEIPT_QUERY = /* GraphQL */ `
+  query GoodsReceipt($id: ID!) {
+    goodsReceipt(id: $id) { ${GOODS_RECEIPT_DETAIL_FIELDS} }
+  }
+`;
+export const RECEIVABLE_PURCHASE_ORDER_LINES_QUERY = /* GraphQL */ `
+  query ReceivablePurchaseOrderLines($options: ReceivablePurchaseOrderLinesOptions) {
+    receivablePurchaseOrderLines(options: $options) { ${RECEIVABLE_LINE_FIELDS} }
+  }
+`;
+export const POST_GOODS_RECEIPT_MUTATION = /* GraphQL */ `
+  mutation PostGoodsReceipt($input: PostGoodsReceiptInput!, $idempotencyKey: String!) {
+    postGoodsReceipt(input: $input, idempotencyKey: $idempotencyKey) { ${GOODS_RECEIPT_FIELDS} }
+  }
+`;
+export const REVERSE_GOODS_RECEIPT_MUTATION = /* GraphQL */ `
+  mutation ReverseGoodsReceipt($input: ReverseGoodsReceiptInput!, $idempotencyKey: String!) {
+    reverseGoodsReceipt(input: $input, idempotencyKey: $idempotencyKey) {
+      ${GOODS_RECEIPT_FIELDS}
+    }
+  }
+`;
+export const ADD_GOODS_RECEIPT_CHARGE_MUTATION = /* GraphQL */ `
+  mutation AddGoodsReceiptCharge($input: AddGoodsReceiptChargeInput!, $idempotencyKey: String) {
+    addGoodsReceiptCharge(input: $input, idempotencyKey: $idempotencyKey) {
+      ${GOODS_RECEIPT_DETAIL_FIELDS}
+    }
+  }
+`;
+export const REMOVE_GOODS_RECEIPT_CHARGE_MUTATION = /* GraphQL */ `
+  mutation RemoveGoodsReceiptCharge(
+    $input: RemoveGoodsReceiptChargeInput!
+    $idempotencyKey: String
+  ) {
+    removeGoodsReceiptCharge(input: $input, idempotencyKey: $idempotencyKey) {
+      ${GOODS_RECEIPT_DETAIL_FIELDS}
+    }
+  }
+`;
+const DEFAULT_PAGE_SIZE = 25;
+const LIST_FILTERS = ['purchaseOrderId', 'supplierId', 'stockLocationId', 'kind', 'term'];
+const RECEIVABLE_FILTERS = ['supplierId', 'stockLocationId', 'purchaseOrderId'];
+const LINE_INPUT_FIELDS = [
+    'purchaseOrderLineId',
+    'acceptedBaseQuantity',
+    'rejectedBaseQuantity',
+    'rejectReason',
+    'overReceiptReason',
+    'traceability',
+];
+const CHARGE_INPUT_FIELDS = [
+    'goodsReceiptId',
+    'kind',
+    'label',
+    'payeeSupplierId',
+    'payeeName',
+    'currencyCode',
+    'amount',
+    'allocation',
+    'incurredOn',
+    'fxRate',
+];
+const POST_INPUT_FIELDS = [
+    'supplierId',
+    'stockLocationId',
+    'receivedOn',
+    'supplierDeliveryRef',
+    'fxRates',
+];
+function picked(input, fields) {
+    const out = {};
+    for (const field of fields) {
+        const value = input[field];
+        if (value !== undefined)
+            out[field] = value;
+    }
+    return out;
+}
+export function createPurchasingReceiptsModule(transport) {
+    const listPage = async (skip, take, options) => {
+        const filters = options ? picked(options, LIST_FILTERS) : {};
+        const data = await transport.graphql({
+            api: 'admin',
+            query: GOODS_RECEIPTS_QUERY,
+            variables: { options: { skip, take, ...filters } },
+        }, options);
+        return pageFromVendureList(data.goodsReceipts, skip, take, (cursor) => listPage(readOffsetCursor(cursor), take, options));
+    };
+    return {
+        async list(options) {
+            const take = options?.limit ?? DEFAULT_PAGE_SIZE;
+            const skip = options?.after === undefined ? 0 : readOffsetCursor(options.after);
+            return listPage(skip, take, options);
+        },
+        async get(id, call) {
+            const data = await transport.graphql({ api: 'admin', query: GOODS_RECEIPT_QUERY, variables: { id } }, call);
+            return data.goodsReceipt;
+        },
+        async receivable(options) {
+            const filters = options ? picked(options, RECEIVABLE_FILTERS) : {};
+            const data = await transport.graphql({
+                api: 'admin',
+                query: RECEIVABLE_PURCHASE_ORDER_LINES_QUERY,
+                variables: Object.keys(filters).length > 0 ? { options: filters } : {},
+            }, options);
+            return data.receivablePurchaseOrderLines;
+        },
+        async post(input, call) {
+            const data = await transport.graphql({
+                api: 'admin',
+                query: POST_GOODS_RECEIPT_MUTATION,
+                variables: {
+                    input: {
+                        ...picked(input, POST_INPUT_FIELDS),
+                        lines: input.lines.map((line) => picked(line, LINE_INPUT_FIELDS)),
+                    },
+                    idempotencyKey: call.idempotencyKey,
+                },
+            }, call);
+            return data.postGoodsReceipt;
+        },
+        async reverse(input, call) {
+            const data = await transport.graphql({
+                api: 'admin',
+                query: REVERSE_GOODS_RECEIPT_MUTATION,
+                variables: {
+                    input: {
+                        goodsReceiptId: input.goodsReceiptId,
+                        reason: input.reason,
+                        ...(input.lines === undefined ? {} : { lines: input.lines }),
+                    },
+                    idempotencyKey: call.idempotencyKey,
+                },
+            }, call);
+            return data.reverseGoodsReceipt;
+        },
+        charges: {
+            async add(input, call) {
+                const data = await transport.graphql({
+                    api: 'admin',
+                    query: ADD_GOODS_RECEIPT_CHARGE_MUTATION,
+                    variables: {
+                        input: picked(input, CHARGE_INPUT_FIELDS),
+                        idempotencyKey: call?.idempotencyKey,
+                    },
+                }, call);
+                return data.addGoodsReceiptCharge;
+            },
+            async remove(input, call) {
+                const data = await transport.graphql({
+                    api: 'admin',
+                    query: REMOVE_GOODS_RECEIPT_CHARGE_MUTATION,
+                    variables: {
+                        input: { chargeId: input.chargeId, reason: input.reason },
+                        idempotencyKey: call?.idempotencyKey,
+                    },
+                }, call);
+                return data.removeGoodsReceiptCharge;
+            },
+        },
+    };
+}

package/dist/purchasing/returns.d.ts

@@ -0,0 +1,273 @@
+import { type Page, type Transport } from '@sixtyninecommerce/core';
+import type { Call, ListOptions } from '../types.js';
+import type { PurchaseOrderLocation, PurchaseOrderSupplier } from './purchase-orders.js';
+/**
+ * A supplier return's status (purchase-orders spec §7.3): `draft → shipped → resolved`, and
+ * `draft → cancelled`. The meta catalog serves the machine (`admin.meta.catalog()` →
+ * `transitions.supplierReturn`) and its labels. A string on the wire: more statuses may arrive.
+ */
+export type SupplierReturnStatus = 'draft' | 'shipped' | 'resolved' | 'cancelled' | (string & {});
+/** Refused goods sent back from a receipt (`rejected`), or goods from stock (`on_hand`). */
+export type SupplierReturnOrigin = 'rejected' | 'on_hand' | (string & {});
+/** What is expected of the supplier for a line. */
+export type SupplierReturnOutcome = 'credit_expected' | 'replacement_expected' | 'written_off' | (string & {});
+/** What became of a line; `open` until the supplier answered. */
+export type SupplierReturnResolution = 'open' | 'credited' | 'replaced' | 'written_off' | (string & {});
+/**
+ * One line of a supplier return (spec §7.1, §8.9): base units of one goods receipt line going back
+ * to the supplier. `unitCost` is a decimal string of minor units with six decimals: parse it with a
+ * decimal library, not `Number`.
+ */
+export interface SupplierReturnLine {
+    id: string;
+    supplierReturnId: string;
+    position: number;
+    goodsReceiptId: string;
+    /** The goods receipt's number. */
+    goodsReceiptCode: string;
+    /** The receipt line the goods came in on: it fixes the cost they leave at. */
+    goodsReceiptLineId: string;
+    purchaseOrderId: string;
+    /** The purchase order's number. */
+    purchaseOrderCode: string;
+    purchaseOrderLineId: string;
+    productVariantId: string;
+    /** The purchase order line's snapshots. */
+    sku: string;
+    name: string;
+    supplierSku: string | null;
+    purchaseUnitLabel: string | null;
+    purchaseUnitFactor: number;
+    /** Base units going back. */
+    baseQuantity: number;
+    reason: string;
+    outcome: SupplierReturnOutcome;
+    resolution: SupplierReturnResolution;
+    /** The receipt line's supplier currency: a credit amount is stated in it. */
+    currencyCode: string;
+    /** Informational: what the supplier credited, minor units of `currencyCode`. */
+    creditAmount: number | null;
+    /** The supplier's credit note or replacement delivery reference. */
+    resolutionReference: string | null;
+    /**
+     * What the cost ledger took each unit out at when a return from stock shipped, minor units of
+     * the purchasing currency; null for refused goods and before the return ships.
+     */
+    unitCost: string | null;
+    /** What this line cancelled on its purchase order line. */
+    cancelledBaseQuantity: number;
+    /** What this line re-opened on its purchase order line (goods from stock to be replaced). */
+    reopenedBaseQuantity: number;
+    /** ISO-8601 UTC. */
+    resolvedAt: string | null;
+    resolvedByRef: string | null;
+    stockMovementId: string | null;
+    /** ISO-8601 UTC. */
+    createdAt: string;
+}
+/** One move of a supplier return's status, oldest first. */
+export interface SupplierReturnStatusEntry {
+    id: string;
+    /** Null on the entry that records the return's creation. */
+    fromStatus: SupplierReturnStatus | null;
+    status: SupplierReturnStatus;
+    actorRef: string | null;
+    reason: string | null;
+    metadata: Record<string, unknown> | null;
+    /** ISO-8601 UTC. */
+    createdAt: string;
+}
+/**
+ * A return of goods to ONE supplier from ONE stock location, of the active store's PURCHASING
+ * SCOPE (purchase-orders spec §7.1, §8.9): refused goods from a receipt (no stock effect), or goods
+ * from stock (they leave the location when the return ships).
+ */
+export interface SupplierReturn {
+    id: string;
+    /** The legal entity's id, or `sandbox:<channelId>` for a sandbox store. */
+    scopeId: string;
+    legalEntityId: string | null;
+    /** The store that raised it. */
+    originChannelId: string;
+    /** The supplier-return number (`RS-…`; `TEST-RS-…` in a sandbox store). */
+    code: string;
+    status: SupplierReturnStatus;
+    origin: SupplierReturnOrigin;
+    supplierId: string;
+    supplier: PurchaseOrderSupplier | null;
+    /** Where the goods leave from. */
+    stockLocationId: string;
+    stockLocation: PurchaseOrderLocation | null;
+    /** The supplier's return authorisation (RMA) number. */
+    supplierReference: string | null;
+    notesToSupplier: string | null;
+    carrier: string | null;
+    trackingCode: string | null;
+    /** ISO-8601 UTC. */
+    shippedAt: string | null;
+    /** ISO-8601 UTC. */
+    resolvedAt: string | null;
+    managedBy: string | null;
+    externalId: string | null;
+    createdByRef: string | null;
+    /** When the return's PDF was drawn (at ship); null without one. ISO-8601 UTC. */
+    documentIssuedAt: string | null;
+    lines: SupplierReturnLine[];
+    statusHistory: SupplierReturnStatusEntry[];
+    /** ISO-8601 UTC. */
+    createdAt: string;
+    /** ISO-8601 UTC. */
+    updatedAt: string;
+}
+/** A five-minute signed link to a shipped return's PDF. */
+export interface SupplierReturnDocumentUrl {
+    url: string;
+    /** ISO-8601 UTC. */
+    expiresAt: string;
+    filename: string;
+}
+export interface SupplierReturnListOptions extends ListOptions {
+    status?: 'draft' | 'shipped' | 'resolved' | 'cancelled';
+    origin?: 'rejected' | 'on_hand';
+    supplierId?: string;
+    stockLocationId?: string;
+    /** Returns with a line of this purchase order. */
+    purchaseOrderId?: string;
+    /** Returns with a line of this goods receipt. */
+    goodsReceiptId?: string;
+    /** Matches the number, the supplier's reference or the tracking code, case-insensitively. */
+    term?: string;
+}
+export interface SupplierReturnLineInput {
+    /** A line of a goods receipt (not of a reversal) of the return's supplier. */
+    goodsReceiptLineId: string;
+    /** Base units going back: at most what the receipt line still holds to return. */
+    baseQuantity: number;
+    /** Why; refused goods take the receipt line's reason when left out, goods from stock need one. */
+    reason?: string;
+    outcome: 'credit_expected' | 'replacement_expected' | 'written_off';
+}
+export interface CreateSupplierReturnInput {
+    origin: 'rejected' | 'on_hand';
+    /** The lines' supplier; named, it must be theirs. */
+    supplierId?: string;
+    /**
+     * Refused goods: the receipts' location (named, it must be it). From stock: a stock location of
+     * the store the legal entity owns; the receipts' when left out.
+     */
+    stockLocationId?: string;
+    supplierReference?: string;
+    notesToSupplier?: string;
+    carrier?: string;
+    trackingCode?: string;
+    lines: SupplierReturnLineInput[];
+}
+/** A change of a return: a field left out is kept, `null` clears it. */
+export interface UpdateSupplierReturnInput {
+    /** A draft from stock only; `null` takes the receipts' location again. */
+    stockLocationId?: string | null;
+    supplierReference?: string | null;
+    /** A draft only. */
+    notesToSupplier?: string | null;
+    carrier?: string | null;
+    trackingCode?: string | null;
+    /** A draft only: every line, in its new order. */
+    lines?: SupplierReturnLineInput[];
+}
+export interface ShipSupplierReturnInput {
+    carrier?: string;
+    trackingCode?: string;
+    /** Email the supplier the return's PDF ("Supplier Return Sent"); `true` when left out. */
+    notifySupplier?: boolean;
+}
+export interface ResolveSupplierReturnLineInput {
+    supplierReturnLineId: string;
+    resolution: 'credited' | 'replaced' | 'written_off';
+    /** Informational, a credited line only: minor units of the line's `currencyCode`. */
+    creditAmount?: number;
+    /** The supplier's credit note or replacement delivery reference. */
+    resolutionReference?: string;
+}
+/** A cancel, with the staff's optional reason. */
+export interface SupplierReturnCancelOptions extends Call {
+    reason?: string;
+}
+/** A ship must carry its idempotency key (spec §10.1). */
+export type SupplierReturnKeyedCall = Call & {
+    idempotencyKey: string;
+};
+export declare const SUPPLIER_RETURN_LINE_FIELDS = "\n  id\n  supplierReturnId\n  position\n  goodsReceiptId\n  goodsReceiptCode\n  goodsReceiptLineId\n  purchaseOrderId\n  purchaseOrderCode\n  purchaseOrderLineId\n  productVariantId\n  sku\n  name\n  supplierSku\n  purchaseUnitLabel\n  purchaseUnitFactor\n  baseQuantity\n  reason\n  outcome\n  resolution\n  currencyCode\n  creditAmount\n  resolutionReference\n  unitCost\n  cancelledBaseQuantity\n  reopenedBaseQuantity\n  resolvedAt\n  resolvedByRef\n  stockMovementId\n  createdAt\n";
+export declare const SUPPLIER_RETURN_FIELDS = "\n  id\n  scopeId\n  legalEntityId\n  originChannelId\n  code\n  status\n  origin\n  supplierId\n  supplier { id code name status }\n  stockLocationId\n  stockLocation { id name }\n  supplierReference\n  notesToSupplier\n  carrier\n  trackingCode\n  shippedAt\n  resolvedAt\n  managedBy\n  externalId\n  createdByRef\n  documentIssuedAt\n  lines { \n  id\n  supplierReturnId\n  position\n  goodsReceiptId\n  goodsReceiptCode\n  goodsReceiptLineId\n  purchaseOrderId\n  purchaseOrderCode\n  purchaseOrderLineId\n  productVariantId\n  sku\n  name\n  supplierSku\n  purchaseUnitLabel\n  purchaseUnitFactor\n  baseQuantity\n  reason\n  outcome\n  resolution\n  currencyCode\n  creditAmount\n  resolutionReference\n  unitCost\n  cancelledBaseQuantity\n  reopenedBaseQuantity\n  resolvedAt\n  resolvedByRef\n  stockMovementId\n  createdAt\n }\n  statusHistory { id fromStatus status actorRef reason metadata createdAt }\n  createdAt\n  updatedAt\n";
+export declare const SUPPLIER_RETURNS_QUERY = "\n  query SupplierReturns($options: SupplierReturnListOptions) {\n    supplierReturns(options: $options) {\n      items { \n  id\n  scopeId\n  legalEntityId\n  originChannelId\n  code\n  status\n  origin\n  supplierId\n  supplier { id code name status }\n  stockLocationId\n  stockLocation { id name }\n  supplierReference\n  notesToSupplier\n  carrier\n  trackingCode\n  shippedAt\n  resolvedAt\n  managedBy\n  externalId\n  createdByRef\n  documentIssuedAt\n  lines { \n  id\n  supplierReturnId\n  position\n  goodsReceiptId\n  goodsReceiptCode\n  goodsReceiptLineId\n  purchaseOrderId\n  purchaseOrderCode\n  purchaseOrderLineId\n  productVariantId\n  sku\n  name\n  supplierSku\n  purchaseUnitLabel\n  purchaseUnitFactor\n  baseQuantity\n  reason\n  outcome\n  resolution\n  currencyCode\n  creditAmount\n  resolutionReference\n  unitCost\n  cancelledBaseQuantity\n  reopenedBaseQuantity\n  resolvedAt\n  resolvedByRef\n  stockMovementId\n  createdAt\n }\n  statusHistory { id fromStatus status actorRef reason metadata createdAt }\n  createdAt\n  updatedAt\n }\n      totalItems\n    }\n  }\n";
+export declare const SUPPLIER_RETURN_QUERY = "\n  query SupplierReturn($id: ID!) {\n    supplierReturn(id: $id) { \n  id\n  scopeId\n  legalEntityId\n  originChannelId\n  code\n  status\n  origin\n  supplierId\n  supplier { id code name status }\n  stockLocationId\n  stockLocation { id name }\n  supplierReference\n  notesToSupplier\n  carrier\n  trackingCode\n  shippedAt\n  resolvedAt\n  managedBy\n  externalId\n  createdByRef\n  documentIssuedAt\n  lines { \n  id\n  supplierReturnId\n  position\n  goodsReceiptId\n  goodsReceiptCode\n  goodsReceiptLineId\n  purchaseOrderId\n  purchaseOrderCode\n  purchaseOrderLineId\n  productVariantId\n  sku\n  name\n  supplierSku\n  purchaseUnitLabel\n  purchaseUnitFactor\n  baseQuantity\n  reason\n  outcome\n  resolution\n  currencyCode\n  creditAmount\n  resolutionReference\n  unitCost\n  cancelledBaseQuantity\n  reopenedBaseQuantity\n  resolvedAt\n  resolvedByRef\n  stockMovementId\n  createdAt\n }\n  statusHistory { id fromStatus status actorRef reason metadata createdAt }\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const CREATE_SUPPLIER_RETURN_MUTATION = "\n  mutation CreateSupplierReturn($input: CreateSupplierReturnInput!, $idempotencyKey: String) {\n    createSupplierReturn(input: $input, idempotencyKey: $idempotencyKey) {\n      \n  id\n  scopeId\n  legalEntityId\n  originChannelId\n  code\n  status\n  origin\n  supplierId\n  supplier { id code name status }\n  stockLocationId\n  stockLocation { id name }\n  supplierReference\n  notesToSupplier\n  carrier\n  trackingCode\n  shippedAt\n  resolvedAt\n  managedBy\n  externalId\n  createdByRef\n  documentIssuedAt\n  lines { \n  id\n  supplierReturnId\n  position\n  goodsReceiptId\n  goodsReceiptCode\n  goodsReceiptLineId\n  purchaseOrderId\n  purchaseOrderCode\n  purchaseOrderLineId\n  productVariantId\n  sku\n  name\n  supplierSku\n  purchaseUnitLabel\n  purchaseUnitFactor\n  baseQuantity\n  reason\n  outcome\n  resolution\n  currencyCode\n  creditAmount\n  resolutionReference\n  unitCost\n  cancelledBaseQuantity\n  reopenedBaseQuantity\n  resolvedAt\n  resolvedByRef\n  stockMovementId\n  createdAt\n }\n  statusHistory { id fromStatus status actorRef reason metadata createdAt }\n  createdAt\n  updatedAt\n\n    }\n  }\n";
+export declare const UPDATE_SUPPLIER_RETURN_MUTATION = "\n  mutation UpdateSupplierReturn($input: UpdateSupplierReturnInput!, $idempotencyKey: String) {\n    updateSupplierReturn(input: $input, idempotencyKey: $idempotencyKey) {\n      \n  id\n  scopeId\n  legalEntityId\n  originChannelId\n  code\n  status\n  origin\n  supplierId\n  supplier { id code name status }\n  stockLocationId\n  stockLocation { id name }\n  supplierReference\n  notesToSupplier\n  carrier\n  trackingCode\n  shippedAt\n  resolvedAt\n  managedBy\n  externalId\n  createdByRef\n  documentIssuedAt\n  lines { \n  id\n  supplierReturnId\n  position\n  goodsReceiptId\n  goodsReceiptCode\n  goodsReceiptLineId\n  purchaseOrderId\n  purchaseOrderCode\n  purchaseOrderLineId\n  productVariantId\n  sku\n  name\n  supplierSku\n  purchaseUnitLabel\n  purchaseUnitFactor\n  baseQuantity\n  reason\n  outcome\n  resolution\n  currencyCode\n  creditAmount\n  resolutionReference\n  unitCost\n  cancelledBaseQuantity\n  reopenedBaseQuantity\n  resolvedAt\n  resolvedByRef\n  stockMovementId\n  createdAt\n }\n  statusHistory { id fromStatus status actorRef reason metadata createdAt }\n  createdAt\n  updatedAt\n\n    }\n  }\n";
+export declare const SHIP_SUPPLIER_RETURN_MUTATION = "\n  mutation ShipSupplierReturn($input: ShipSupplierReturnInput!, $idempotencyKey: String!) {\n    shipSupplierReturn(input: $input, idempotencyKey: $idempotencyKey) {\n      \n  id\n  scopeId\n  legalEntityId\n  originChannelId\n  code\n  status\n  origin\n  supplierId\n  supplier { id code name status }\n  stockLocationId\n  stockLocation { id name }\n  supplierReference\n  notesToSupplier\n  carrier\n  trackingCode\n  shippedAt\n  resolvedAt\n  managedBy\n  externalId\n  createdByRef\n  documentIssuedAt\n  lines { \n  id\n  supplierReturnId\n  position\n  goodsReceiptId\n  goodsReceiptCode\n  goodsReceiptLineId\n  purchaseOrderId\n  purchaseOrderCode\n  purchaseOrderLineId\n  productVariantId\n  sku\n  name\n  supplierSku\n  purchaseUnitLabel\n  purchaseUnitFactor\n  baseQuantity\n  reason\n  outcome\n  resolution\n  currencyCode\n  creditAmount\n  resolutionReference\n  unitCost\n  cancelledBaseQuantity\n  reopenedBaseQuantity\n  resolvedAt\n  resolvedByRef\n  stockMovementId\n  createdAt\n }\n  statusHistory { id fromStatus status actorRef reason metadata createdAt }\n  createdAt\n  updatedAt\n\n    }\n  }\n";
+export declare const RESOLVE_SUPPLIER_RETURN_LINE_MUTATION = "\n  mutation ResolveSupplierReturnLine(\n    $input: ResolveSupplierReturnLineInput!\n    $idempotencyKey: String\n  ) {\n    resolveSupplierReturnLine(input: $input, idempotencyKey: $idempotencyKey) {\n      \n  id\n  scopeId\n  legalEntityId\n  originChannelId\n  code\n  status\n  origin\n  supplierId\n  supplier { id code name status }\n  stockLocationId\n  stockLocation { id name }\n  supplierReference\n  notesToSupplier\n  carrier\n  trackingCode\n  shippedAt\n  resolvedAt\n  managedBy\n  externalId\n  createdByRef\n  documentIssuedAt\n  lines { \n  id\n  supplierReturnId\n  position\n  goodsReceiptId\n  goodsReceiptCode\n  goodsReceiptLineId\n  purchaseOrderId\n  purchaseOrderCode\n  purchaseOrderLineId\n  productVariantId\n  sku\n  name\n  supplierSku\n  purchaseUnitLabel\n  purchaseUnitFactor\n  baseQuantity\n  reason\n  outcome\n  resolution\n  currencyCode\n  creditAmount\n  resolutionReference\n  unitCost\n  cancelledBaseQuantity\n  reopenedBaseQuantity\n  resolvedAt\n  resolvedByRef\n  stockMovementId\n  createdAt\n }\n  statusHistory { id fromStatus status actorRef reason metadata createdAt }\n  createdAt\n  updatedAt\n\n    }\n  }\n";
+export declare const CANCEL_SUPPLIER_RETURN_MUTATION = "\n  mutation CancelSupplierReturn($id: ID!, $reason: String, $idempotencyKey: String) {\n    cancelSupplierReturn(id: $id, reason: $reason, idempotencyKey: $idempotencyKey) {\n      \n  id\n  scopeId\n  legalEntityId\n  originChannelId\n  code\n  status\n  origin\n  supplierId\n  supplier { id code name status }\n  stockLocationId\n  stockLocation { id name }\n  supplierReference\n  notesToSupplier\n  carrier\n  trackingCode\n  shippedAt\n  resolvedAt\n  managedBy\n  externalId\n  createdByRef\n  documentIssuedAt\n  lines { \n  id\n  supplierReturnId\n  position\n  goodsReceiptId\n  goodsReceiptCode\n  goodsReceiptLineId\n  purchaseOrderId\n  purchaseOrderCode\n  purchaseOrderLineId\n  productVariantId\n  sku\n  name\n  supplierSku\n  purchaseUnitLabel\n  purchaseUnitFactor\n  baseQuantity\n  reason\n  outcome\n  resolution\n  currencyCode\n  creditAmount\n  resolutionReference\n  unitCost\n  cancelledBaseQuantity\n  reopenedBaseQuantity\n  resolvedAt\n  resolvedByRef\n  stockMovementId\n  createdAt\n }\n  statusHistory { id fromStatus status actorRef reason metadata createdAt }\n  createdAt\n  updatedAt\n\n    }\n  }\n";
+export declare const CREATE_SUPPLIER_RETURN_DOCUMENT_URL_MUTATION = "\n  mutation CreateSupplierReturnDocumentUrl($supplierReturnId: ID!) {\n    createSupplierReturnDocumentUrl(supplierReturnId: $supplierReturnId) {\n      url\n      expiresAt\n      filename\n    }\n  }\n";
+/**
+ * `admin.purchasing.returns` (purchase-orders spec §8.9, §10.1): returns of goods to suppliers —
+ * refused goods from a goods receipt, or goods found faulty later, from stock. Every method needs
+ * the Purchasing plugin on the store and purchasing switched on for its legal entity
+ * (`PURCHASING_NOT_ENABLED`, 422; `PLUGIN_ACCESS_DENIED`, 403, for an ordinary caller). Reads and
+ * `document` need `ReadPurchaseOrder` or `ReceivePurchaseOrder`; `create` needs
+ * `CreatePurchaseOrder`, `update`, `resolveLine` and `cancel` `UpdatePurchaseOrder`, and `ship`
+ * `ReceivePurchaseOrder`, each on EVERY store of the legal entity (`SHARED_SELLER_NOT_ALLOWED`,
+ * 403). `ship` REQUIRES an idempotency key: a retried ship answers the first one, it never takes
+ * the goods out of stock twice.
+ */
+export interface PurchasingReturnsModule {
+    /** The scope's returns, newest first. */
+    list(options?: SupplierReturnListOptions): Promise<Page<SupplierReturn>>;
+    /** One return; null when none has that id in the scope. */
+    get(id: string, call?: Call): Promise<SupplierReturn | null>;
+    /**
+     * Raises a draft return (spec §8.9), numbered `RS-…`: each line names the goods receipt line its
+     * goods came in on, of a receipt of ONE supplier; refused goods leave from the receipts'
+     * location, goods from stock from the location named (else the receipts'). Refusals:
+     * `GOODS_RECEIPT_NOT_FOUND` (404), `SUPPLIER_RETURN_EXCEEDS_RETURNABLE` (422; `details` per line
+     * with `returnableBaseQuantity`), `SUPPLIER_ARCHIVED` (422), `LOCATION_NOT_IN_CHANNEL`,
+     * `LOCATION_NOT_ALLOWED` (403), `LOCATION_NOT_OWNED_BY_ENTITY`, `SUPPLIER_RETURN_INVALID` (400).
+     */
+    create(input: CreateSupplierReturnInput, call?: Call): Promise<SupplierReturn>;
+    /**
+     * Changes a draft (its lines, location, notes and references), or a SHIPPED return's carrier,
+     * tracking code and supplier reference. Refusals: `SUPPLIER_RETURN_NOT_FOUND` (404),
+     * `SUPPLIER_RETURN_INVALID_TRANSITION` (422), `SUPPLIER_RETURN_EXCEEDS_RETURNABLE` (422),
+     * `SUPPLIER_RETURN_INVALID` (400).
+     */
+    update(id: string, input: UpdateSupplierReturnInput, call?: Call): Promise<SupplierReturn>;
+    /**
+     * Ships a draft return (spec §8.9): goods from stock leave the location at their receipt lines'
+     * landed cost; refused goods credited or written off are cancelled on their purchase order
+     * lines, goods from stock to be replaced are open there again (an order closes or reopens
+     * accordingly); the PDF is drawn and, unless `notifySupplier: false`, emailed to the supplier.
+     * Refusals, before anything changes: `SUPPLIER_RETURN_INVALID_TRANSITION` (422, not a draft),
+     * `SUPPLIER_RETURN_EXCEEDS_RETURNABLE` (422), `STOCK_WOULD_GO_NEGATIVE` (422: move or recount
+     * stock first), `FIELD_GROUP_LOCKED` (an app owns a variant's stock), `LOCATION_NOT_ALLOWED`
+     * (403), and by email `SUPPLIER_HAS_NO_ORDER_EMAIL`, `SUPPLIER_EMAIL_UNDELIVERABLE`,
+     * `PRIVATE_STORAGE_UNCONFIGURED` (422, `details[0]` with `field: 'notifySupplier'`). The key is
+     * required.
+     */
+    ship(id: string, input: ShipSupplierReturnInput, call: SupplierReturnKeyedCall): Promise<SupplierReturn>;
+    /**
+     * Records what the supplier did with one line of a shipped return: `credited` (with an
+     * informational `creditAmount`), `replaced` or `written_off`; the last line resolved resolves the
+     * return. Refusals: `SUPPLIER_RETURN_NOT_FOUND` (404), `SUPPLIER_RETURN_INVALID_TRANSITION`
+     * (422, not shipped, or the line resolved already), `SUPPLIER_RETURN_INVALID` (400, a
+     * resolution that does not settle the line's outcome).
+     */
+    resolveLine(input: ResolveSupplierReturnLineInput, call?: Call): Promise<SupplierReturn>;
+    /**
+     * Cancels a draft: its lines no longer hold their quantities. A shipped return is never
+     * cancelled (`SUPPLIER_RETURN_INVALID_TRANSITION`, 422).
+     */
+    cancel(id: string, options?: SupplierReturnCancelOptions): Promise<SupplierReturn>;
+    /**
+     * A five-minute link to a shipped return's PDF. Refusal: `SUPPLIER_RETURN_DOCUMENT_NOT_FOUND`
+     * (404: not shipped, or shipped on a deployment without a private document bucket).
+     */
+    document(id: string, call?: Call): Promise<SupplierReturnDocumentUrl>;
+}
+export declare function createPurchasingReturnsModule(transport: Transport): PurchasingReturnsModule;