AlmondTill/G3N API

NewReturnInput

input type

Create-input to request a Return. The org (ACTIVE) + the receiving LF (ACTIVE, same spine) + the order (same-group, ∈ {placed, completed}) + the optional invoice (belongs to the order) are gated live; nonReturnable/finalSale lines refuse CONFLICT/NOT_RETURNABLE; the returnable remainder pre-checks at create (NON-binding — the BINDING check is the receive stamp).

Fields

FieldTypeRequiredNotes
captionStringnoOptional: when omitted the per-type default applies — the order sysId + line count (return of SO-… 2 lines); when supplied it must be non-blank.
orderIdID ID!yesThe Order being returned against — same-group; ∈ {placed, completed} (CONFLICT/REF_STATE else).
invoiceIdIDnoOptional Invoice ref — same-group + must belong to the order (the receipted-return audit edge).
logicalFacilityIdID ID!yesThe processing/receiving LF — becomes the parent.
linesReturnLineInput [ReturnLineInput!]!yesThe returned lines (1..45, distinct orderLineNos).

Used by