Newer Version Available

This content describes an older version of this product. View Latest

BuyerAccount

Represents an account that is enabled as a buyer for Lightning B2B Commerce. This object is available in API version 48.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Special Access Rules

The BuyerAccount object is available only if the B2B Commerce license is enabled.

Fields

Field Details
AvailableCredit
Type
currency
Properties
Filter, Nillable, Sort
Description
The amount of credit available to a buyer account.
This is a calculated field.
BuyerId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the buyer account.
This is a relationship field.
Relationship Name
Buyer
Relationship Type
Lookup
Refers To
Account

This field is unique within your organization.

Note

BuyerStatus
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Status of the buyer account.
Possible values are:
  • Active
  • Inactive
  • On Hold
  • Pending
The default value is 'Pending'.
CommerceType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
The type of commerce that the buyer account is conducting, using the Commerce app.
Possible values are:
  • Buyer
  • Reseller
  • Seller
The default value is 'Buyer'.
CreditLimit
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The limit of credit available to the buyer account.
CreditStatus
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
The type or status of the buyer account's credit ranking.
Possible values are:
  • Bad Credit
  • Delinquent
  • Good Credit
  • On Hold
The default value is 'Good Credit'.
CurrencyIsoCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Three-letter ISO currency code associated with the buyer account record.
Possible values are:
  • USD—U.S. Dollar
The default value is 'USD'.
CurrentBalance
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The balance carried by the buyer account.
IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the buyer account is active (true) or not (false).
The default value is 'false'.
MaximumOrderLimit
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The maximum number of orders that can be placed by the buyer account.
MinimumOrderLimit
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The minimum number of orders that can be placed by the buyer account.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the buyer account.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the buyer account owner.
This is a relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
User
PayerId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the buyer account payer.
This is a relationship field.
Relationship Name
Payer
Relationship Type
Lookup
Refers To
Account
SendToId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of account that an order is sent to.
This is a relationship field.
Relationship Name
SendTo
Relationship Type
Lookup
Refers To
Account

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

BuyerAccountFeed
Feed tracking is available for the object.
BuyerAccountHistory
History is available for tracked fields of the object.
BuyerAccountShare
Sharing is available for the object.