AlmondTill/G3N API

On this page

corporateCustomer

query · in the family Corporate customer

What it does

Look up one record — a corporate customer — a business buyer with house terms.

A CorporateCustomer by id, within the caller's OWN org-group family; requires authentication. A cross-tenant id reads as null (not-found) AND trips the rootId tripwire server-side.

What happens

Reads only — changes nothing.

Who may call it

Capability area: Reading your records — Looking up and listing the records of your organization.

Arguments

NameTypeRequiredNotes
idID ID!yesThe id of the record.

Returns

CorporateCustomer — A CorporateCustomer — WHO the merchant SELLS TO on business terms: the shared B2B customer MASTER, the sell-side mirror of the Vendor supplier master. Group-parented + deliberately thin (caption = the trading name · legalName · taxId · code): contact data + buyers ride the Contact/ContactAssignment family (a CorporateCustomer is an assignment HOST — buyers are purchasing-buyer-role assignments); the org-specific commercial payload (terms · credit · price group · addresses) IS the OrgCustomer relationship (an active OrgCustomer = the B2B selling enablement — the OrgVendor mirror). SEARCHABLE (a customer book you can't search by name fails its purpose — the law). Doom is blocked by NON-doomed OrgCustomer selections and LIVE hosted ContactAssignments; open ORDERS naming the customer never block — order refs re-validate FRESH at place. NOT an identity class (buyer auth/portal is); the customer hierarchy (parent company) is a NAMED deferral.

Example request

query ExampleCorporateCustomer($id: ID!) {
  corporateCustomer(id: $id) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    legalName
    taxId
    code
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000"
}

Example response

{
  "data": {
    "corporateCustomer": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "CU-EXMP-0000-000F",
      "type": "CorporateCustomer",
      "caption": "Blue jeans",
      "status": "active",
      "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",
      "legalName": "Blue jeans",
      "taxId": "<tax id>",
      "code": "BJ-001"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer