AlmondTill/G3N API

Organization

object type

An organization — THE CONTAINER: a merchant's operating organization within its org group.

Fields

FieldTypeNotes
idID ID!No further notes.
sysIdString String!The group-scoped human-facing system id (OR-…) — the account-number-style immutable org id.
typeString String!No further notes.
captionString String!No further notes.
statusString String!The FSM state: active | parked | suspended | doomed.
parentIdID ID!The parent org group; for an Organization parentId === rootId.
rootIdID ID!The org-group family root.
createdAtString String!No further notes.
updatedAtString String!No further notes.
revisionNumInt Int!No further notes.
revisionID ID!The OCC revision token — supply it on every mutation of this record; rotates on every write.
refCaptionsRefCaption [RefCaption!]!The server-composed captions of this record's declared references (the referenced-caption rule): owners → the Account captions (caption ONLY — never email/loginName) · primaryPhysicalFacility → the PF caption · costCentre → the CostCentre caption (by sysId).
jurisdictionString String!ISO-3166 country — the org's ONE locked jurisdiction.
codeString String!Mutable human-readable organization code.
legalNameString String!The registered legal name; the org IS the legal facility.
brandNameStringOptional trading brand name; absent = trades under the legal name.
operatingAsNameStringOptional operating-as / DBA name.
ownersID [ID!]!The owner Account ids; the composite create sets the creating principal's Account.
costCentreStringThe org's EXACTLY-ONE CostCentre sysId (CC-…) — kit-minted WITH the org; the envelope attribution anchor. Null only on a pre- org.
primaryPhysicalFacilityIDThe designated PRIMARY PhysicalFacility id. Null only on a pre-composite (bootstrap-seeded) org.
defaultCurrencyStringThe org's DEFAULT trading currency. Optional — but an org may not SELECT a Style until it carries one, and every selected style's non-doomed Products must price it (CONFLICT/CURRENCY_FLOOR, the three-site closure).
stripeAccountRefStringThe org's Stripe Connect account ref (acct_…, 'each org = a connected account') — KIT-STAMPED by provisionStripeAccount, IMMUTABLE once set (never caller-editable). Null = unprovisioned (card payments route the platform account).
stripeChargesEnabledBooleanWhether the connected account can take DIRECT charges (charges_enabled; the applyTender card lane routes direct only when true). Stamped at provision + refreshStripeAccountStatus. Null = unprovisioned.
stripeDetailsSubmittedBooleanWhether the merchant completed Stripe-hosted onboarding (details_submitted). Stamped at provision + refresh. Null = unprovisioned.
ownerVerificationsOwnerVerificationStanding [OwnerVerificationStanding!]!The owner seats' identity-verification standings. COMPLIANCE STATUS ONLY, never identity data — Stripe custodies the documents; the platform stores the outcome.

Used by