---
schema_version: "1"
id: b3d1a96c118f00a626b2727159544e74ba95f6f545c90f7941a1d68293a72737
title: BuyerAccount
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_buyeraccount.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_buyeraccount.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: e0c63bcd6061d43a1850440b2d448c3bb007eebf36cae962af7104f35874bff1
description: Represents an account that is enabled as a buyer for Lightning B2B Commerce. This object is available in API version 48.0 and later.
---
# 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

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d315395e111">Field</th>

              <th class="featureTableHeader  " id="d315395e114">Details</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d315395e111" data-title="Field"><span class="keyword parmname">AvailableCredit</span></td>

              <td class="entry" headers="d315395e114" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">currency</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Filter, Nillable, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The amount of credit available to a buyer account.</dd>

                  <dd class="dd">This is a calculated field.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d315395e111" data-title="Field"><span class="keyword parmname">BuyerId</span></td>

              <td class="entry" headers="d315395e114" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">reference</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Filter, Group, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The ID of the buyer account.</dd>

                  <dd class="dd">This is a relationship field.</dd>



                  <dt class="dt dlterm">Relationship Name</dt>

                  <dd class="dd">Buyer</dd>



                  <dt class="dt dlterm">Relationship Type</dt>

                  <dd class="dd">Lookup</dd>



                  <dt class="dt dlterm">Refers To</dt>

                  <dd class="dd">Account</dd>


                </dl>

                <div class="box message info">
                  <div class="inner">
                    <div class="bd">
                      <div class="media">
                        <img class="img mtm" src="https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/images/icon_note.png" alt="Note">
                        <div class="mediaBd">
                          <h4 class="mbs">Note</h4>
                          <p>This field is unique within your organization.</p>
                        </div>
                      </div>
                    </div>
                  </div>
                </div>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d315395e111" data-title="Field"><span class="keyword parmname">BuyerStatus</span></td>

              <td class="entry" headers="d315395e114" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">picklist</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Defaulted on create, Filter, Group, Nillable, Sort,
                    Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Status of the buyer account.</dd>

                  <dd class="dd">Possible values are: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">Active</samp></li>

                      <li class="li"><samp class="codeph nolang">Inactive</samp></li>

                      <li class="li"><samp class="codeph nolang">On Hold</samp></li>

                      <li class="li"><samp class="codeph nolang">Pending</samp></li>

                    </ul>

                  </dd>

                  <dd class="dd">The default value is 'Pending'.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d315395e111" data-title="Field"><span class="keyword parmname">CommerceType</span></td>

              <td class="entry" headers="d315395e114" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">picklist</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Defaulted on create, Filter, Group, Nillable, Sort,
                    Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The type of commerce that the buyer account is conducting, using
                    the Commerce app.</dd>

                  <dd class="dd">Possible values are: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">Buyer</samp></li>

                      <li class="li"><samp class="codeph nolang">Reseller</samp></li>

                      <li class="li"><samp class="codeph nolang">Seller</samp></li>

                    </ul>

                  </dd>

                  <dd class="dd">The default value is 'Buyer'.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d315395e111" data-title="Field"><span class="keyword parmname">CreditLimit</span></td>

              <td class="entry" headers="d315395e114" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">currency</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Filter, Nillable, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The limit of credit available to the buyer account.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d315395e111" data-title="Field"><span class="keyword parmname">CreditStatus</span></td>

              <td class="entry" headers="d315395e114" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">picklist</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Defaulted on create, Filter, Group, Nillable, Sort,
                    Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The type or status of the buyer account's credit ranking.</dd>

                  <dd class="dd">Possible values are: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">Bad Credit</samp></li>

                      <li class="li"><samp class="codeph nolang">Delinquent</samp></li>

                      <li class="li"><samp class="codeph nolang">Good Credit</samp></li>

                      <li class="li"><samp class="codeph nolang">On Hold</samp></li>

                    </ul>

                  </dd>

                  <dd class="dd">The default value is 'Good Credit'.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d315395e111" data-title="Field"><span class="keyword parmname">CurrencyIsoCode</span></td>

              <td class="entry" headers="d315395e114" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">picklist</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Defaulted on create, Filter, Group, Nillable, Restricted
                    picklist, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Three-letter ISO currency code associated with the buyer account
                    record.</dd>

                  <dd class="dd">Possible values are: <ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">USD</samp>—U.S.
                        Dollar
                      </li>

                    </ul>
                  </dd>

                  <dd class="dd">The default value is 'USD'.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d315395e111" data-title="Field"><span class="keyword parmname">CurrentBalance</span></td>

              <td class="entry" headers="d315395e114" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">currency</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Filter, Nillable, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The balance carried by the buyer account.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d315395e111" data-title="Field"><span class="keyword parmname">IsActive</span></td>

              <td class="entry" headers="d315395e114" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">boolean</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Defaulted on create, Filter, Group, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Indicates whether the buyer account is active
                    (<samp class="ph systemoutput">true</samp>) or not
                    (<samp class="ph systemoutput">false</samp>).</dd>

                  <dd class="dd">The default value is 'false'.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d315395e111" data-title="Field"><span class="keyword parmname">MaximumOrderLimit</span></td>

              <td class="entry" headers="d315395e114" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">currency</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Filter, Nillable, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The maximum number of orders that can be placed by the buyer
                    account.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d315395e111" data-title="Field"><span class="keyword parmname">MinimumOrderLimit</span></td>

              <td class="entry" headers="d315395e114" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">currency</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Filter, Nillable, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The minimum number of orders that can be placed by the buyer
                    account.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d315395e111" data-title="Field"><span class="keyword parmname">Name</span></td>

              <td class="entry" headers="d315395e114" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Filter, Group, idLookup, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The name of the buyer account.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d315395e111" data-title="Field"><span class="keyword parmname">OwnerId</span></td>

              <td class="entry" headers="d315395e114" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">reference</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Defaulted on create, Filter, Group, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The ID of the buyer account owner.</dd>

                  <dd class="dd">This is a relationship field.</dd>



                  <dt class="dt dlterm">Relationship Name</dt>

                  <dd class="dd">Owner</dd>



                  <dt class="dt dlterm">Relationship Type</dt>

                  <dd class="dd">Lookup</dd>



                  <dt class="dt dlterm">Refers To</dt>

                  <dd class="dd">User</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d315395e111" data-title="Field"><span class="keyword parmname">PayerId</span></td>

              <td class="entry" headers="d315395e114" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">reference</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Filter, Group, Nillable, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The ID of the buyer account payer.</dd>

                  <dd class="dd">This is a relationship field.</dd>



                  <dt class="dt dlterm">Relationship Name</dt>

                  <dd class="dd">Payer</dd>



                  <dt class="dt dlterm">Relationship Type</dt>

                  <dd class="dd">Lookup</dd>



                  <dt class="dt dlterm">Refers To</dt>

                  <dd class="dd">Account</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d315395e111" data-title="Field"><span class="keyword parmname">SendToId</span></td>

              <td class="entry" headers="d315395e114" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">reference</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Filter, Group, Nillable, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The ID of account that an order is sent to.</dd>

                  <dd class="dd">This is a relationship field.</dd>



                  <dt class="dt dlterm">Relationship Name</dt>

                  <dd class="dd">SendTo</dd>



                  <dt class="dt dlterm">Relationship Type</dt>

                  <dd class="dd">Lookup</dd>



                  <dt class="dt dlterm">Refers To</dt>

                  <dd class="dd">Account</dd>


                </dl>

              </td>

            </tr>

          </tbody>

        </table>

## 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](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.")

Feed tracking is available for the object.

[BuyerAccountHistory](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.")

History is available for tracked fields of the object.

[BuyerAccountShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.")

Sharing is available for the object.