Skip to main content

CustomerBranch

a partner sales branch — an Address with isBranch = true. The label is the branch name; pendingApprovalCount feeds the deactivation warning (EDGE #4).

type CustomerBranch {
  approverCount: Int!
  approvers: [CustomerBranchMemberSummary!]!
  id: ID!
  isActive: Boolean!
  isBranch: Boolean!
  label: String
  memberCount: Int!
  members: [CustomerBranchMemberSummary!]!
  orderLimit: Float
  pendingApprovalCount: Int!
}

Fields

`CustomerBranch.approverCount` ● `Int!` non-null scalar

How many approvers the branch has.

`CustomerBranch.approvers` ● `[CustomerBranchMemberSummary!]!` non-null object

The approvers of the branch.

`CustomerBranch.id` ● `ID!` non-null scalar

The unique ID of this record.

`CustomerBranch.isActive` ● `Boolean!` non-null scalar

Branch active = Address.isActive.

`CustomerBranch.isBranch` ● `Boolean!` non-null scalar

True when this is a branch of the company.

`CustomerBranch.label` ● `String` scalar

The branch display name (the address label).

`CustomerBranch.memberCount` ● `Int!` non-null scalar

How many members the branch has.

`CustomerBranch.members` ● `[CustomerBranchMemberSummary!]!` non-null object

The members of the branch.

`CustomerBranch.orderLimit` ● `Float` scalar

Order-value ceiling for any manager ordering for this branch (org base currency; null = unlimited).

`CustomerBranch.pendingApprovalCount` ● `Int!` non-null scalar

PENDING approval requests parked against this branch (deactivation warning — EDGE #4).

Returned By

assignBranchManagers mutation ● customerBranches query ● myBranches query ● removeBranchManager mutation ● setBranchActive mutation ● setBranchFlag mutation ● setBranchLimit mutation

Fields
Returned By