@sixtyninecommerce/admin 0.10.0 → 0.12.0

package/dist/purchasing/receipts.d.ts

@@ -0,0 +1,396 @@
+import { type Page, type Transport } from '@sixtyninecommerce/core';
+import type { Call, ListOptions } from '../types.js';
+import type { PurchaseOrderLocation, PurchaseOrderSupplier } from './purchase-orders.js';
+/** A receipt, or the reversal that takes goods of one back. A string on the wire. */
+export type GoodsReceiptKind = 'receipt' | 'reversal' | (string & {});
+/** One lot of a receipt line: captured for traceability; stock is not tracked per lot. */
+export interface GoodsReceiptTraceability {
+    lot: string | null;
+    /** `YYYY-MM-DD`. */
+    expiresOn: string | null;
+    serials: string[];
+}
+/**
+ * One line of a goods receipt: what arrived for one purchase order line, in base (stock) units
+ * (purchase-orders spec §7.1, §8.6). Costs are decimal strings of minor units with six decimals,
+ * the exchange rate one with eight: parse them with a decimal library, not `Number`.
+ */
+export interface GoodsReceiptLine {
+    id: string;
+    goodsReceiptId: string;
+    purchaseOrderId: string;
+    /** The purchase order's number. */
+    purchaseOrderCode: string;
+    purchaseOrderLineId: string;
+    /** On a reversal line, the receipt line it takes goods back from. */
+    reversesLineId: string | null;
+    productVariantId: string;
+    /** The purchase order line's snapshots. */
+    sku: string;
+    name: string;
+    supplierSku: string | null;
+    purchaseUnitLabel: string | null;
+    purchaseUnitFactor: number;
+    /** Base units that entered stock (on a reversal line: that left it again). */
+    acceptedBaseQuantity: number;
+    /** Base units refused at the door: no stock moved; they stay open on the order line. */
+    rejectedBaseQuantity: number;
+    rejectReason: string | null;
+    overReceiptReason: string | null;
+    /**
+     * What the supplier's no-backorders rule cancelled of the order line's remainder; on a
+     * reversal line, minus what it gave back. 0 otherwise.
+     */
+    cancelledBaseQuantity: number;
+    /** On a receipt line, what reversals took back of it so far; 0 on a reversal line. */
+    reversedBaseQuantity: number;
+    /**
+     * On a receipt line, what supplier returns from stock (not cancelled, drafts included) take of
+     * its accepted units; a reversal can no longer take those back. 0 on a reversal line.
+     */
+    returnedBaseQuantity: number;
+    /** On a receipt line, what supplier returns of refused goods take of its rejected units. */
+    returnedRejectedBaseQuantity: number;
+    /** The purchase order's currency (what the supplier is paid in). */
+    supplierCurrencyCode: string;
+    unitCostSupplierCurrency: string;
+    /** Units of the purchasing currency per unit of `supplierCurrencyCode`. */
+    fxRate: string;
+    /** `platform` (the synced rate of the receipt day, or up to 7 days earlier) or `override`. */
+    fxRateSource: 'platform' | 'override' | (string & {});
+    /** The platform rate's own date (ISO-8601); null for an override or the purchasing currency. */
+    fxRateDate: string | null;
+    /** Per base unit, minor units of the receipt's `currencyCode`. */
+    unitCostEntityCurrency: string;
+    /** What the weighted average took in per base unit, minor units of `currencyCode`. */
+    landedUnitCost: string;
+    traceability: GoodsReceiptTraceability[];
+    stockMovementId: string | null;
+    externalLineId: string | null;
+    /** ISO-8601 UTC. */
+    createdAt: string;
+}
+/** A goods receipt that refers to another (a reversal of it). */
+export interface GoodsReceiptReference {
+    id: string;
+    code: string;
+    /** ISO-8601 UTC. */
+    createdAt: string;
+}
+/**
+ * A goods receipt of the active store's PURCHASING SCOPE (purchase-orders spec §7.1, §8.6, §8.7):
+ * the goods one supplier delivered at one stock location against lines of its sent purchase
+ * orders, or (`kind: 'reversal'`) the counter-document taking goods of an earlier receipt back.
+ * Immutable: every correction is another document.
+ */
+export interface GoodsReceipt {
+    id: string;
+    /** The legal entity's id, or `sandbox:<channelId>` for a sandbox store. */
+    scopeId: string;
+    legalEntityId: string | null;
+    /** The store that posted it. */
+    originChannelId: string;
+    /** The goods-receipt number (a reversal takes the next one of the same series). */
+    code: string;
+    kind: GoodsReceiptKind;
+    reversesReceiptId: string | null;
+    reversesReceiptCode: string | null;
+    supplierId: string;
+    supplier: PurchaseOrderSupplier | null;
+    stockLocationId: string;
+    stockLocation: PurchaseOrderLocation | null;
+    /** The day the goods arrived (`YYYY-MM-DD`) in the location's time zone. */
+    receivedOn: string;
+    /** ISO-8601 UTC. */
+    receivedAt: string;
+    /** The purchasing currency the lines' entity-currency costs are in. */
+    currencyCode: string;
+    supplierDeliveryRef: string | null;
+    /** Why a reversal takes the goods back. */
+    reason: string | null;
+    managedBy: string | null;
+    externalId: string | null;
+    externalNumber: string | null;
+    /** Who received: a credential's staff reference, else `<kind>:<id>` of the caller. */
+    actorRef: string | null;
+    createdByRef: string | null;
+    /** Its reversals, oldest first; empty on a reversal. */
+    reversals: GoodsReceiptReference[];
+    lines: GoodsReceiptLine[];
+    /** ISO-8601 UTC. */
+    createdAt: string;
+}
+/**
+ * A line of a SENT purchase order the active store can receive at one of its stock locations,
+ * with the keys a scan resolves (spec §8.6.1: supplier barcode → supplier SKU → GTIN → SKU) and
+ * what it may still accept within its over-receipt tolerance (§8.6.2). Quantities in base units.
+ */
+export interface ReceivablePurchaseOrderLine {
+    purchaseOrderId: string;
+    purchaseOrderCode: string;
+    purchaseOrderLineId: string;
+    position: number;
+    supplierId: string;
+    supplier: PurchaseOrderSupplier;
+    stockLocationId: string;
+    productVariantId: string;
+    sku: string;
+    name: string;
+    supplierSku: string | null;
+    supplierBarcode: string | null;
+    gtin: string | null;
+    purchaseUnitLabel: string | null;
+    purchaseUnitFactor: number;
+    orderedBaseQuantity: number;
+    cancelledBaseQuantity: number;
+    receivedBaseQuantity: number;
+    returnedForReplacementBaseQuantity: number;
+    /** ordered − cancelled − received + returned for replacement; below 0 is over-received. */
+    remainingBaseQuantity: number;
+    /** The over-receipt allowance in base units. */
+    toleranceBaseQuantity: number;
+    /** What the line may still accept without `ReceiveOverTolerance`. */
+    maxAcceptedBaseQuantity: number;
+    confirmedBaseQuantity: number | null;
+    /** `YYYY-MM-DD`: the confirmed day, else the requested one. */
+    expectedOn: string | null;
+}
+export interface GoodsReceiptListOptions extends ListOptions {
+    /** Receipts with a line of this purchase order. */
+    purchaseOrderId?: string;
+    supplierId?: string;
+    stockLocationId?: string;
+    kind?: 'receipt' | 'reversal';
+    /** Matches the number or the supplier's delivery reference, case-insensitively, as typed. */
+    term?: string;
+}
+export interface ReceivablePurchaseOrderLinesOptions extends Call {
+    supplierId?: string;
+    /** A stock location of the active store; every one of its locations when left out. */
+    stockLocationId?: string;
+    purchaseOrderId?: string;
+}
+export interface GoodsReceiptTraceabilityInput {
+    lot?: string | null;
+    /** `YYYY-MM-DD`. */
+    expiresOn?: string | null;
+    serials?: string[] | null;
+}
+export interface PostGoodsReceiptLineInput {
+    purchaseOrderLineId: string;
+    /** Base units that enter stock; 0 when everything was refused. */
+    acceptedBaseQuantity: number;
+    /** Base units refused at the door. */
+    rejectedBaseQuantity?: number;
+    /** Required with a rejected quantity. */
+    rejectReason?: string;
+    /** Required, with `ReceiveOverTolerance`, when the line accepts more than its tolerance. */
+    overReceiptReason?: string;
+    traceability?: GoodsReceiptTraceabilityInput[];
+}
+export interface PostGoodsReceiptInput {
+    /** The lines' supplier; named, it must be theirs. */
+    supplierId?: string;
+    /** Where the lines' orders deliver to; named, it must be theirs. */
+    stockLocationId?: string;
+    /** `YYYY-MM-DD` in the location's time zone; today when left out. */
+    receivedOn?: string;
+    supplierDeliveryRef?: string;
+    /** Rates stated instead of the platform's (needs `ManageInventoryCost`). */
+    fxRates?: Array<{
+        currencyCode: string;
+        rate: string;
+    }>;
+    lines: PostGoodsReceiptLineInput[];
+}
+export interface ReverseGoodsReceiptInput {
+    goodsReceiptId: string;
+    /** Why the receipt was wrong. */
+    reason: string;
+    /** Left out: every line, all it still holds. */
+    lines?: Array<{
+        goodsReceiptLineId: string;
+        baseQuantity: number;
+    }>;
+}
+/** A receipt write must carry its idempotency key (spec §8.6.1, §10.1). */
+export type GoodsReceiptKeyedCall = Call & {
+    idempotencyKey: string;
+};
+/** What a landed charge paid for. A string on the wire. */
+export type LandedChargeKind = 'freight' | 'duty' | 'fee' | 'other' | (string & {});
+/** How a landed charge is spread over a receipt's lines. A string on the wire. */
+export type LandedChargeAllocationBasis = 'value' | 'quantity' | 'weight' | (string & {});
+/** One receipt line's share of a landed charge, frozen when the charge was applied. */
+export interface LandedChargeAllocation {
+    goodsReceiptLineId: string;
+    productVariantId: string;
+    /** The base units the line still held of the receipt (accepted less reversed) when applied. */
+    baseQuantity: number;
+    /** Its value in minor units (by value), its base units (quantity) or its grams (weight). */
+    basis: string;
+    /** The line's share, minor units of the receipt's `currencyCode` (six decimals). */
+    amount: string;
+    /** What the line's `landedUnitCost` rose by, per base unit. */
+    unitCostDelta: string;
+}
+/**
+ * A landed charge (purchase-orders spec §8.10.4): freight, duty or a fee paid to get a receipt's
+ * goods in, spread over its accepted lines and taken into their weighted average cost. Never
+ * deleted: a removed one keeps `removedAt` and its reason.
+ */
+export interface LandedCharge {
+    id: string;
+    /** The posted receipt it is allocated over. */
+    goodsReceiptId: string | null;
+    /** The purchase order a charge entered on an order belongs to; null for a receipt's own. */
+    purchaseOrderId: string | null;
+    kind: LandedChargeKind;
+    label: string | null;
+    payeeSupplierId: string | null;
+    payeeSupplier: PurchaseOrderSupplier | null;
+    /** Who billed it, as free text (a forwarder that is no supplier). */
+    payeeName: string | null;
+    /** What the payee billed in. */
+    currencyCode: string;
+    /** Whole minor units of `currencyCode`. */
+    amount: number;
+    allocation: LandedChargeAllocationBasis;
+    /** `YYYY-MM-DD` in the legal entity's time zone. */
+    incurredOn: string;
+    /** Units of the purchasing currency per unit of `currencyCode` (eight decimals). */
+    fxRate: string;
+    /** `platform` (the synced rate of `incurredOn`, or up to 7 days earlier) or `override`. */
+    fxRateSource: 'platform' | 'override' | (string & {});
+    /** ISO-8601; null for an override or a charge in the purchasing currency. */
+    fxRateDate: string | null;
+    /** The amount in minor units of the receipt's `currencyCode` (six decimals). */
+    amountEntityCurrency: string;
+    allocations: LandedChargeAllocation[];
+    /** ISO-8601 UTC. */
+    appliedAt: string | null;
+    /** ISO-8601 UTC; null while the charge stands. */
+    removedAt: string | null;
+    removeReason: string | null;
+    removedByRef: string | null;
+    createdByRef: string | null;
+    /** ISO-8601 UTC. */
+    createdAt: string;
+}
+/** A goods receipt with its landed charges, as `get` and the charge writes answer it. */
+export interface GoodsReceiptDetail extends GoodsReceipt {
+    /** Oldest first, removed ones included (`removedAt` set); empty on a reversal. */
+    charges: LandedCharge[];
+}
+export interface AddGoodsReceiptChargeInput {
+    /** A posted receipt (not a reversal). */
+    goodsReceiptId: string;
+    kind: 'freight' | 'duty' | 'fee' | 'other';
+    label?: string;
+    /** A supplier of the legal entity that billed it; or `payeeName`, never both. */
+    payeeSupplierId?: string;
+    payeeName?: string;
+    /** What the payee billed in; the receipt's (purchasing) currency when left out. */
+    currencyCode?: string;
+    /** Whole minor units of `currencyCode`, above 0. */
+    amount: number;
+    /** `value` when left out. */
+    allocation?: 'value' | 'quantity' | 'weight';
+    /** `YYYY-MM-DD` in the legal entity's time zone; today when left out. */
+    incurredOn?: string;
+    /** A rate stated instead of the platform's (a charge in another currency only). */
+    fxRate?: string;
+}
+export interface RemoveGoodsReceiptChargeInput {
+    chargeId: string;
+    /** Why the charge comes off. */
+    reason: string;
+}
+export declare const GOODS_RECEIPT_LINE_FIELDS = "\n  id\n  goodsReceiptId\n  purchaseOrderId\n  purchaseOrderCode\n  purchaseOrderLineId\n  reversesLineId\n  productVariantId\n  sku\n  name\n  supplierSku\n  purchaseUnitLabel\n  purchaseUnitFactor\n  acceptedBaseQuantity\n  rejectedBaseQuantity\n  rejectReason\n  overReceiptReason\n  cancelledBaseQuantity\n  reversedBaseQuantity\n  returnedBaseQuantity\n  returnedRejectedBaseQuantity\n  supplierCurrencyCode\n  unitCostSupplierCurrency\n  fxRate\n  fxRateSource\n  fxRateDate\n  unitCostEntityCurrency\n  landedUnitCost\n  traceability { lot expiresOn serials }\n  stockMovementId\n  externalLineId\n  createdAt\n";
+export declare const GOODS_RECEIPT_FIELDS = "\n  id\n  scopeId\n  legalEntityId\n  originChannelId\n  code\n  kind\n  reversesReceiptId\n  reversesReceiptCode\n  supplierId\n  supplier { id code name status }\n  stockLocationId\n  stockLocation { id name }\n  receivedOn\n  receivedAt\n  currencyCode\n  supplierDeliveryRef\n  reason\n  managedBy\n  externalId\n  externalNumber\n  actorRef\n  createdByRef\n  reversals { id code createdAt }\n  lines { \n  id\n  goodsReceiptId\n  purchaseOrderId\n  purchaseOrderCode\n  purchaseOrderLineId\n  reversesLineId\n  productVariantId\n  sku\n  name\n  supplierSku\n  purchaseUnitLabel\n  purchaseUnitFactor\n  acceptedBaseQuantity\n  rejectedBaseQuantity\n  rejectReason\n  overReceiptReason\n  cancelledBaseQuantity\n  reversedBaseQuantity\n  returnedBaseQuantity\n  returnedRejectedBaseQuantity\n  supplierCurrencyCode\n  unitCostSupplierCurrency\n  fxRate\n  fxRateSource\n  fxRateDate\n  unitCostEntityCurrency\n  landedUnitCost\n  traceability { lot expiresOn serials }\n  stockMovementId\n  externalLineId\n  createdAt\n }\n  createdAt\n";
+export declare const LANDED_CHARGE_FIELDS = "\n  id\n  goodsReceiptId\n  purchaseOrderId\n  kind\n  label\n  payeeSupplierId\n  payeeSupplier { id code name status }\n  payeeName\n  currencyCode\n  amount\n  allocation\n  incurredOn\n  fxRate\n  fxRateSource\n  fxRateDate\n  amountEntityCurrency\n  allocations { goodsReceiptLineId productVariantId baseQuantity basis amount unitCostDelta }\n  appliedAt\n  removedAt\n  removeReason\n  removedByRef\n  createdByRef\n  createdAt\n";
+/** A receipt with its landed charges: `get` and the charge writes. */
+export declare const GOODS_RECEIPT_DETAIL_FIELDS = "\n  \n  id\n  scopeId\n  legalEntityId\n  originChannelId\n  code\n  kind\n  reversesReceiptId\n  reversesReceiptCode\n  supplierId\n  supplier { id code name status }\n  stockLocationId\n  stockLocation { id name }\n  receivedOn\n  receivedAt\n  currencyCode\n  supplierDeliveryRef\n  reason\n  managedBy\n  externalId\n  externalNumber\n  actorRef\n  createdByRef\n  reversals { id code createdAt }\n  lines { \n  id\n  goodsReceiptId\n  purchaseOrderId\n  purchaseOrderCode\n  purchaseOrderLineId\n  reversesLineId\n  productVariantId\n  sku\n  name\n  supplierSku\n  purchaseUnitLabel\n  purchaseUnitFactor\n  acceptedBaseQuantity\n  rejectedBaseQuantity\n  rejectReason\n  overReceiptReason\n  cancelledBaseQuantity\n  reversedBaseQuantity\n  returnedBaseQuantity\n  returnedRejectedBaseQuantity\n  supplierCurrencyCode\n  unitCostSupplierCurrency\n  fxRate\n  fxRateSource\n  fxRateDate\n  unitCostEntityCurrency\n  landedUnitCost\n  traceability { lot expiresOn serials }\n  stockMovementId\n  externalLineId\n  createdAt\n }\n  createdAt\n\n  charges { \n  id\n  goodsReceiptId\n  purchaseOrderId\n  kind\n  label\n  payeeSupplierId\n  payeeSupplier { id code name status }\n  payeeName\n  currencyCode\n  amount\n  allocation\n  incurredOn\n  fxRate\n  fxRateSource\n  fxRateDate\n  amountEntityCurrency\n  allocations { goodsReceiptLineId productVariantId baseQuantity basis amount unitCostDelta }\n  appliedAt\n  removedAt\n  removeReason\n  removedByRef\n  createdByRef\n  createdAt\n }\n";
+export declare const RECEIVABLE_LINE_FIELDS = "\n  purchaseOrderId\n  purchaseOrderCode\n  purchaseOrderLineId\n  position\n  supplierId\n  supplier { id code name status }\n  stockLocationId\n  productVariantId\n  sku\n  name\n  supplierSku\n  supplierBarcode\n  gtin\n  purchaseUnitLabel\n  purchaseUnitFactor\n  orderedBaseQuantity\n  cancelledBaseQuantity\n  receivedBaseQuantity\n  returnedForReplacementBaseQuantity\n  remainingBaseQuantity\n  toleranceBaseQuantity\n  maxAcceptedBaseQuantity\n  confirmedBaseQuantity\n  expectedOn\n";
+export declare const GOODS_RECEIPTS_QUERY = "\n  query GoodsReceipts($options: GoodsReceiptListOptions) {\n    goodsReceipts(options: $options) {\n      items { \n  id\n  scopeId\n  legalEntityId\n  originChannelId\n  code\n  kind\n  reversesReceiptId\n  reversesReceiptCode\n  supplierId\n  supplier { id code name status }\n  stockLocationId\n  stockLocation { id name }\n  receivedOn\n  receivedAt\n  currencyCode\n  supplierDeliveryRef\n  reason\n  managedBy\n  externalId\n  externalNumber\n  actorRef\n  createdByRef\n  reversals { id code createdAt }\n  lines { \n  id\n  goodsReceiptId\n  purchaseOrderId\n  purchaseOrderCode\n  purchaseOrderLineId\n  reversesLineId\n  productVariantId\n  sku\n  name\n  supplierSku\n  purchaseUnitLabel\n  purchaseUnitFactor\n  acceptedBaseQuantity\n  rejectedBaseQuantity\n  rejectReason\n  overReceiptReason\n  cancelledBaseQuantity\n  reversedBaseQuantity\n  returnedBaseQuantity\n  returnedRejectedBaseQuantity\n  supplierCurrencyCode\n  unitCostSupplierCurrency\n  fxRate\n  fxRateSource\n  fxRateDate\n  unitCostEntityCurrency\n  landedUnitCost\n  traceability { lot expiresOn serials }\n  stockMovementId\n  externalLineId\n  createdAt\n }\n  createdAt\n }\n      totalItems\n    }\n  }\n";
+export declare const GOODS_RECEIPT_QUERY = "\n  query GoodsReceipt($id: ID!) {\n    goodsReceipt(id: $id) { \n  \n  id\n  scopeId\n  legalEntityId\n  originChannelId\n  code\n  kind\n  reversesReceiptId\n  reversesReceiptCode\n  supplierId\n  supplier { id code name status }\n  stockLocationId\n  stockLocation { id name }\n  receivedOn\n  receivedAt\n  currencyCode\n  supplierDeliveryRef\n  reason\n  managedBy\n  externalId\n  externalNumber\n  actorRef\n  createdByRef\n  reversals { id code createdAt }\n  lines { \n  id\n  goodsReceiptId\n  purchaseOrderId\n  purchaseOrderCode\n  purchaseOrderLineId\n  reversesLineId\n  productVariantId\n  sku\n  name\n  supplierSku\n  purchaseUnitLabel\n  purchaseUnitFactor\n  acceptedBaseQuantity\n  rejectedBaseQuantity\n  rejectReason\n  overReceiptReason\n  cancelledBaseQuantity\n  reversedBaseQuantity\n  returnedBaseQuantity\n  returnedRejectedBaseQuantity\n  supplierCurrencyCode\n  unitCostSupplierCurrency\n  fxRate\n  fxRateSource\n  fxRateDate\n  unitCostEntityCurrency\n  landedUnitCost\n  traceability { lot expiresOn serials }\n  stockMovementId\n  externalLineId\n  createdAt\n }\n  createdAt\n\n  charges { \n  id\n  goodsReceiptId\n  purchaseOrderId\n  kind\n  label\n  payeeSupplierId\n  payeeSupplier { id code name status }\n  payeeName\n  currencyCode\n  amount\n  allocation\n  incurredOn\n  fxRate\n  fxRateSource\n  fxRateDate\n  amountEntityCurrency\n  allocations { goodsReceiptLineId productVariantId baseQuantity basis amount unitCostDelta }\n  appliedAt\n  removedAt\n  removeReason\n  removedByRef\n  createdByRef\n  createdAt\n }\n }\n  }\n";
+export declare const RECEIVABLE_PURCHASE_ORDER_LINES_QUERY = "\n  query ReceivablePurchaseOrderLines($options: ReceivablePurchaseOrderLinesOptions) {\n    receivablePurchaseOrderLines(options: $options) { \n  purchaseOrderId\n  purchaseOrderCode\n  purchaseOrderLineId\n  position\n  supplierId\n  supplier { id code name status }\n  stockLocationId\n  productVariantId\n  sku\n  name\n  supplierSku\n  supplierBarcode\n  gtin\n  purchaseUnitLabel\n  purchaseUnitFactor\n  orderedBaseQuantity\n  cancelledBaseQuantity\n  receivedBaseQuantity\n  returnedForReplacementBaseQuantity\n  remainingBaseQuantity\n  toleranceBaseQuantity\n  maxAcceptedBaseQuantity\n  confirmedBaseQuantity\n  expectedOn\n }\n  }\n";
+export declare const POST_GOODS_RECEIPT_MUTATION = "\n  mutation PostGoodsReceipt($input: PostGoodsReceiptInput!, $idempotencyKey: String!) {\n    postGoodsReceipt(input: $input, idempotencyKey: $idempotencyKey) { \n  id\n  scopeId\n  legalEntityId\n  originChannelId\n  code\n  kind\n  reversesReceiptId\n  reversesReceiptCode\n  supplierId\n  supplier { id code name status }\n  stockLocationId\n  stockLocation { id name }\n  receivedOn\n  receivedAt\n  currencyCode\n  supplierDeliveryRef\n  reason\n  managedBy\n  externalId\n  externalNumber\n  actorRef\n  createdByRef\n  reversals { id code createdAt }\n  lines { \n  id\n  goodsReceiptId\n  purchaseOrderId\n  purchaseOrderCode\n  purchaseOrderLineId\n  reversesLineId\n  productVariantId\n  sku\n  name\n  supplierSku\n  purchaseUnitLabel\n  purchaseUnitFactor\n  acceptedBaseQuantity\n  rejectedBaseQuantity\n  rejectReason\n  overReceiptReason\n  cancelledBaseQuantity\n  reversedBaseQuantity\n  returnedBaseQuantity\n  returnedRejectedBaseQuantity\n  supplierCurrencyCode\n  unitCostSupplierCurrency\n  fxRate\n  fxRateSource\n  fxRateDate\n  unitCostEntityCurrency\n  landedUnitCost\n  traceability { lot expiresOn serials }\n  stockMovementId\n  externalLineId\n  createdAt\n }\n  createdAt\n }\n  }\n";
+export declare const REVERSE_GOODS_RECEIPT_MUTATION = "\n  mutation ReverseGoodsReceipt($input: ReverseGoodsReceiptInput!, $idempotencyKey: String!) {\n    reverseGoodsReceipt(input: $input, idempotencyKey: $idempotencyKey) {\n      \n  id\n  scopeId\n  legalEntityId\n  originChannelId\n  code\n  kind\n  reversesReceiptId\n  reversesReceiptCode\n  supplierId\n  supplier { id code name status }\n  stockLocationId\n  stockLocation { id name }\n  receivedOn\n  receivedAt\n  currencyCode\n  supplierDeliveryRef\n  reason\n  managedBy\n  externalId\n  externalNumber\n  actorRef\n  createdByRef\n  reversals { id code createdAt }\n  lines { \n  id\n  goodsReceiptId\n  purchaseOrderId\n  purchaseOrderCode\n  purchaseOrderLineId\n  reversesLineId\n  productVariantId\n  sku\n  name\n  supplierSku\n  purchaseUnitLabel\n  purchaseUnitFactor\n  acceptedBaseQuantity\n  rejectedBaseQuantity\n  rejectReason\n  overReceiptReason\n  cancelledBaseQuantity\n  reversedBaseQuantity\n  returnedBaseQuantity\n  returnedRejectedBaseQuantity\n  supplierCurrencyCode\n  unitCostSupplierCurrency\n  fxRate\n  fxRateSource\n  fxRateDate\n  unitCostEntityCurrency\n  landedUnitCost\n  traceability { lot expiresOn serials }\n  stockMovementId\n  externalLineId\n  createdAt\n }\n  createdAt\n\n    }\n  }\n";
+export declare const ADD_GOODS_RECEIPT_CHARGE_MUTATION = "\n  mutation AddGoodsReceiptCharge($input: AddGoodsReceiptChargeInput!, $idempotencyKey: String) {\n    addGoodsReceiptCharge(input: $input, idempotencyKey: $idempotencyKey) {\n      \n  \n  id\n  scopeId\n  legalEntityId\n  originChannelId\n  code\n  kind\n  reversesReceiptId\n  reversesReceiptCode\n  supplierId\n  supplier { id code name status }\n  stockLocationId\n  stockLocation { id name }\n  receivedOn\n  receivedAt\n  currencyCode\n  supplierDeliveryRef\n  reason\n  managedBy\n  externalId\n  externalNumber\n  actorRef\n  createdByRef\n  reversals { id code createdAt }\n  lines { \n  id\n  goodsReceiptId\n  purchaseOrderId\n  purchaseOrderCode\n  purchaseOrderLineId\n  reversesLineId\n  productVariantId\n  sku\n  name\n  supplierSku\n  purchaseUnitLabel\n  purchaseUnitFactor\n  acceptedBaseQuantity\n  rejectedBaseQuantity\n  rejectReason\n  overReceiptReason\n  cancelledBaseQuantity\n  reversedBaseQuantity\n  returnedBaseQuantity\n  returnedRejectedBaseQuantity\n  supplierCurrencyCode\n  unitCostSupplierCurrency\n  fxRate\n  fxRateSource\n  fxRateDate\n  unitCostEntityCurrency\n  landedUnitCost\n  traceability { lot expiresOn serials }\n  stockMovementId\n  externalLineId\n  createdAt\n }\n  createdAt\n\n  charges { \n  id\n  goodsReceiptId\n  purchaseOrderId\n  kind\n  label\n  payeeSupplierId\n  payeeSupplier { id code name status }\n  payeeName\n  currencyCode\n  amount\n  allocation\n  incurredOn\n  fxRate\n  fxRateSource\n  fxRateDate\n  amountEntityCurrency\n  allocations { goodsReceiptLineId productVariantId baseQuantity basis amount unitCostDelta }\n  appliedAt\n  removedAt\n  removeReason\n  removedByRef\n  createdByRef\n  createdAt\n }\n\n    }\n  }\n";
+export declare const REMOVE_GOODS_RECEIPT_CHARGE_MUTATION = "\n  mutation RemoveGoodsReceiptCharge(\n    $input: RemoveGoodsReceiptChargeInput!\n    $idempotencyKey: String\n  ) {\n    removeGoodsReceiptCharge(input: $input, idempotencyKey: $idempotencyKey) {\n      \n  \n  id\n  scopeId\n  legalEntityId\n  originChannelId\n  code\n  kind\n  reversesReceiptId\n  reversesReceiptCode\n  supplierId\n  supplier { id code name status }\n  stockLocationId\n  stockLocation { id name }\n  receivedOn\n  receivedAt\n  currencyCode\n  supplierDeliveryRef\n  reason\n  managedBy\n  externalId\n  externalNumber\n  actorRef\n  createdByRef\n  reversals { id code createdAt }\n  lines { \n  id\n  goodsReceiptId\n  purchaseOrderId\n  purchaseOrderCode\n  purchaseOrderLineId\n  reversesLineId\n  productVariantId\n  sku\n  name\n  supplierSku\n  purchaseUnitLabel\n  purchaseUnitFactor\n  acceptedBaseQuantity\n  rejectedBaseQuantity\n  rejectReason\n  overReceiptReason\n  cancelledBaseQuantity\n  reversedBaseQuantity\n  returnedBaseQuantity\n  returnedRejectedBaseQuantity\n  supplierCurrencyCode\n  unitCostSupplierCurrency\n  fxRate\n  fxRateSource\n  fxRateDate\n  unitCostEntityCurrency\n  landedUnitCost\n  traceability { lot expiresOn serials }\n  stockMovementId\n  externalLineId\n  createdAt\n }\n  createdAt\n\n  charges { \n  id\n  goodsReceiptId\n  purchaseOrderId\n  kind\n  label\n  payeeSupplierId\n  payeeSupplier { id code name status }\n  payeeName\n  currencyCode\n  amount\n  allocation\n  incurredOn\n  fxRate\n  fxRateSource\n  fxRateDate\n  amountEntityCurrency\n  allocations { goodsReceiptLineId productVariantId baseQuantity basis amount unitCostDelta }\n  appliedAt\n  removedAt\n  removeReason\n  removedByRef\n  createdByRef\n  createdAt\n }\n\n    }\n  }\n";
+/**
+ * `admin.purchasing.receipts` (purchase-orders spec §10.1): receiving goods against the legal
+ * entity's sent purchase orders, and the receipts it posted. 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 need `ReadPurchaseOrder` or
+ * `ReceivePurchaseOrder`; `post` and `reverse` need `ReceivePurchaseOrder` on EVERY store of the
+ * legal entity (`SHARED_SELLER_NOT_ALLOWED`, 403) and REQUIRE an idempotency key: a retried
+ * receipt answers the first one, it never books the stock twice.
+ */
+export interface PurchasingReceiptsModule {
+    /** The scope's receipts and reversals, newest first. */
+    list(options?: GoodsReceiptListOptions): Promise<Page<GoodsReceipt>>;
+    /** One receipt, with its landed `charges`; null when none has that id in the scope. */
+    get(id: string, call?: Call): Promise<GoodsReceiptDetail | null>;
+    /**
+     * The lines of the scope's sent purchase orders delivering to a stock location of the active
+     * store (by order number and position, at most 1000): what the receiving screen and an
+     * integration can receive now, received-in-full lines included. Refusal:
+     * `LOCATION_NOT_IN_CHANNEL` (422) for a location of another store.
+     */
+    receivable(options?: ReceivablePurchaseOrderLinesOptions): Promise<ReceivablePurchaseOrderLine[]>;
+    /**
+     * Receives goods against lines of sent purchase orders of ONE supplier at ONE stock location
+     * (spec §8.6): accepted units enter stock (reason `purchase_receipt`), the weighted average
+     * cost takes them in, the lines' received quantities grow, an order with nothing more to come
+     * closes, and incoming stock follows. Refusals: `RECEIPT_EXCEEDS_TOLERANCE` (422; `details`
+     * per line with `maxAcceptedBaseQuantity`: accepting more needs `ReceiveOverTolerance` and an
+     * `overReceiptReason`), `FX_RATE_UNAVAILABLE` (422, retry once the day's rate synced; the key
+     * is released), `FX_RATE_OVERRIDE_NOT_ALLOWED` (403), `FIELD_GROUP_LOCKED` (an app owns a
+     * variant's stock), `PURCHASE_ORDER_INVALID_TRANSITION` (422, an order not sent),
+     * `PURCHASE_ORDER_LINE_NOT_FOUND` (404), `LOCATION_NOT_IN_CHANNEL`, `LOCATION_NOT_ALLOWED`
+     * (403, a credential's or staff member's locations), `LOCATION_NOT_OWNED_BY_ENTITY`,
+     * `GOODS_RECEIPT_INVALID` (400).
+     */
+    post(input: PostGoodsReceiptInput, call: GoodsReceiptKeyedCall): Promise<GoodsReceipt>;
+    /**
+     * Reverses a receipt, whole or per line (spec §8.7): the goods leave stock again, the cost goes
+     * back at each line's original landed cost, and a closed order reopens when quantity is open
+     * again. For mistakes; goods going back to the supplier are a return. Refusals:
+     * `GOODS_RECEIPT_NOT_FOUND` (404), `RECEIPT_ALREADY_REVERSED` (422; `details` per line with
+     * `reversibleBaseQuantity`), `STOCK_WOULD_GO_NEGATIVE` (422: move or recount stock first),
+     * `FIELD_GROUP_LOCKED`, `LOCATION_NOT_ALLOWED` (403), `GOODS_RECEIPT_INVALID` (400).
+     */
+    reverse(input: ReverseGoodsReceiptInput, call: GoodsReceiptKeyedCall): Promise<GoodsReceipt>;
+    /** Landed charges on posted receipts (freight, duty, fees): `add` and `remove`. */
+    charges: GoodsReceiptChargesModule;
+}
+/**
+ * `admin.purchasing.receipts.charges` (purchase-orders spec §8.10.4, §10.1): landed charges on a
+ * posted receipt. Both need `ManageInventoryCost` on EVERY store of the legal entity
+ * (`SHARED_SELLER_NOT_ALLOWED`, 403) and take an optional idempotency key: a repeat under the key
+ * answers the first call and charges once. Both answer the receipt with its `charges` and the
+ * lines' new `landedUnitCost`.
+ */
+export interface GoodsReceiptChargesModule {
+    /**
+     * Adds a charge: converted into the purchasing currency at the platform rate of `incurredOn`
+     * (or `fxRate`), allocated over the lines' units still held by value, quantity or weight; the
+     * share on units still on hand revalues the weighted average cost, the share on units sold since
+     * is recorded as unabsorbed, and each line's landed unit cost rises by its share. Refusals:
+     * `GOODS_RECEIPT_NOT_FOUND` (404), `LANDED_CHARGE_INVALID` (400), `LANDED_CHARGE_WEIGHT_MISSING`
+     * (422; `details` per variant), `LANDED_CHARGE_NOTHING_TO_ALLOCATE` (422),
+     * `FX_RATE_UNAVAILABLE` (422, retry once the rates synced), `SUPPLIER_NOT_FOUND` (404),
+     * `MANAGED_BY_PROVIDER` (422).
+     */
+    add(input: AddGoodsReceiptChargeInput, call?: Call): Promise<GoodsReceiptDetail>;
+    /**
+     * Removes a charge: the share still on the lines' units comes back out of the average (units
+     * sold since keep theirs), the lines' landed cost drops by what it added, and the charge keeps
+     * `removedAt` and the reason. Refusals: `LANDED_CHARGE_NOT_FOUND` (404),
+     * `LANDED_CHARGE_ALREADY_REMOVED` (422), `LANDED_CHARGE_INVALID` (400).
+     */
+    remove(input: RemoveGoodsReceiptChargeInput, call?: Call): Promise<GoodsReceiptDetail>;
+}
+export declare function createPurchasingReceiptsModule(transport: Transport): PurchasingReceiptsModule;