Skip to main content

Partner

A partner: the one master record for customers and vendors, with its roles, addresses, contacts and account details.

type Partner {
  addresses: [PartnerAddress!]
  assignedSalesRep: CreatedByUser
  assignedSalesRepId: String
  buyingListSummary: PartnerBuyingListSummary!
  code: String!
  contacts: [PartnerContact!]
  createdAt: DateTime!
  createdByUser: CreatedByUser
  creditLimit: Float!
  currentBalance: Float!
  customerAccount: CustomerAccount
  customerEmail: String
  customerTier: String
  deletedAt: DateTime
  deletedBy: String
  description: String
  discountPercent: Float!
  displayName: String
  effectiveTier: EffectiveTierInfo
  enteredBy: String!
  id: ID!
  industry: String
  leadTimeDays: Int!
  ledger: PartnerLedger
  legalName: String
  lifetimeFacts: CustomerLifetimeFacts
  loyaltyPoints: Int!
  metadata: JSON!
  minOrderValue: Float
  name: String!
  notes: String
  organizationId: String!
  otherApplicableDiscount: DiscountScheme
  outstandingPayable: Float
  paymentTerms: String!
  preferredLanguage: String
  previousSalesRep: CreatedByUser
  previousSalesRepId: String
  products: [PartnerProduct!]
  rating: Float
  reassignmentAcknowledgedAt: DateTime
  registrationNumber: String
  registrationSource: String
  repReassignedAt: DateTime
  roles: [PartnerRole!]!
  selfRegistered: Boolean!
  status: PartnerStatus!
  tags: [String!]!
  taxId: String
  type: PartnerType
  updatedAt: DateTime!
  updatedBy: String!
  vendorAccount: VendorAccount
  website: String
}

Fields​

Partner.addresses ● [PartnerAddress!] list object​

The partner's addresses.

Partner.assignedSalesRep ● CreatedByUser object​

The sales rep who owns the customer.

Partner.assignedSalesRepId ● String scalar​

The ID of the sales rep who owns the customer.

Partner.buyingListSummary ● PartnerBuyingListSummary! non-null object​

The customer's saved buying lists, counted: how many lists and how many items across them. A customer with no lists reads zero for both. Read-only: the lists belong to the buyer and are edited in the buyer app or portal.

Partner.code ● String! non-null scalar​

The partner code.

Partner.contacts ● [PartnerContact!] list object​

The partner's contacts.

Partner.createdAt ● DateTime! non-null scalar​

When the record was created.

Partner.createdByUser ● CreatedByUser object​

The user who created the partner.

Partner.creditLimit ● Float! non-null scalar​

The credit limit. 0 or less means unlimited.

Partner.currentBalance ● Float! non-null scalar​

The stored balance. It can drift, so prefer ledger.

Partner.customerAccount ● CustomerAccount object​

The customer-side account details.

Partner.customerEmail ● String scalar​

The email address of the customer's main contact.

Partner.customerTier ● String scalar​

The partner's tier label, set automatically or by hand.

Partner.deletedAt ● DateTime scalar​

When the record was deleted. Empty while the record is live.

Partner.deletedBy ● String scalar​

The ID of the user who deleted the record.

Partner.description ● String scalar​

What the partner is.

Partner.discountPercent ● Float! non-null scalar​

The standing discount, in percent.

Partner.displayName ● String scalar​

The name to show for the partner.

Partner.effectiveTier ● EffectiveTierInfo object​

The customer's tier as it would be charged, with automatic tiering and this month's spend applied.

Partner.enteredBy ● String! non-null scalar​

The ID of the user who created the record.

Partner.id ● ID! non-null scalar​

The unique ID of this record.

Partner.industry ● String scalar​

The partner's industry.

Partner.leadTimeDays ● Int! non-null scalar​

The expected days from order to delivery.

Partner.ledger ● PartnerLedger object​

Both sides of the partner's money position, worked out on every read.

The legal name of the partner.

Partner.lifetimeFacts ● CustomerLifetimeFacts object​

The customer's lifetime order, invoice and payment figures, worked out from the documents.

Partner.loyaltyPoints ● Int! non-null scalar​

The partner's loyalty points.

Partner.metadata ● JSON! non-null scalar​

Additional data attached to the record, as JSON.

Partner.minOrderValue ● Float scalar​

The smallest order value.

Partner.name ● String! non-null scalar​

The name of the partner.

Partner.notes ● String scalar​

Notes about the partner.

Partner.organizationId ● String! non-null scalar​

The ID of the organization the record belongs to.

Partner.otherApplicableDiscount ● DiscountScheme object​

A discount that applies to the customer from another source.

Partner.outstandingPayable ● Float scalar​

What is still owed to the vendor: the total outstanding on open purchase invoices, in the organization's base currency.

Partner.paymentTerms ● String! non-null scalar​

The payment terms agreed with the partner.

Partner.preferredLanguage ● String scalar​

The language of documents sent to the partner. Empty means the organization's default.

Partner.previousSalesRep ● CreatedByUser object​

The rep the customer was moved away from.

Partner.previousSalesRepId ● String scalar​

The ID of the rep the customer was moved away from.

Partner.products ● [PartnerProduct!] list object​

The products the partner supplies or buys.

Partner.rating ● Float scalar​

A rating of the partner.

Partner.reassignmentAcknowledgedAt ● DateTime scalar​

When the previous rep acknowledged the move.

Partner.registrationNumber ● String scalar​

The partner's company registration number.

Partner.registrationSource ● String scalar​

Which app the partner was created in, for example Admin Web or Sales App.

Partner.repReassignedAt ● DateTime scalar​

When the customer was moved to the current rep.

Partner.roles ● [PartnerRole!]! non-null enum​

The roles of the partner, such as customer or supplier.

Partner.selfRegistered ● Boolean! non-null scalar​

True when the customer registered themselves instead of being created by staff.

Partner.status ● PartnerStatus! non-null enum​

The status of the partner.

Partner.tags ● [String!]! non-null scalar​

Tags on the partner.

Partner.taxId ● String scalar​

The partner's tax ID.

Partner.type ● PartnerType enum​

The kind of partner.

Partner.updatedAt ● DateTime! non-null scalar​

When the record was last changed.

Partner.updatedBy ● String! non-null scalar​

The ID of the user who last changed the record.

Partner.vendorAccount ● VendorAccount object​

The vendor-side account details.

Partner.website ● String scalar​

The partner's website.

Returned By​

convertPartnerToCustomer mutation ● convertPartnerToSupplier mutation ● createPartner mutation ● partner query ● partners query ● removePartner mutation ● suppliers query ● togglePartnerRole mutation ● updatePartner mutation ● vendors query

Member Of​

DiscountSchemePartner object ● Invoice object ● Payment object ● ProductReturn object ● Quote object