BillingAccount

Represents the customer's billing controls in the backend system. Used to set up and maintain details such as bill frequency, bill format, and autopay details. This object is available in API version 62.0 and later.

Supported Calls

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

Fields

Field Details
BillCopiesRequested
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The number of bill copies per month requested by the customer.
BillingEmailAddress
Type
email
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Email address to use for email delivery of bills.
ContactPreferenceType
Type
multipicklist
Properties
Create, Filter, Nillable, Update
Description
Specifies the preferred method of communications to the contacts in this account such as mail, email or phone.
Possible values are:
  • Email
  • Phone
  • SMS
CreditRating
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The credit rating of the customer
CreditScore
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The credit score of the customer
CustomerClass
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Speficies the grouping of accounts by attributes such as residential, small or medium businesses etc. Used to drive accounting processes, business logic, and validation rules.
Possible values are:
  • Commercial
  • Industrial
  • Retail
  • Small Scale
ExtlBillCycle
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the grouping that controls when a bill is produced.
Possible values are:
  • Annual
  • Monthly
  • Quarterly
ExtlBillDeliveryMethod
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the chosen method to receive bills.
Possible values are:
  • EBill
  • Paper
  • SMS
ExtlBillFormat
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the format of the bill that the customer receives, such as a detailed or a summary bill.
Possible values are:
  • Detailed Statement
  • Group Bill
  • Summary Bill
ExtlBillFrequency
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the the frequency at which bills are generated such as Monthly, Quarterly or Weekly.
Possible values are:
  • Monthly
  • Quarterly
  • Weekly
ExtlReferenceIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The external identifier for the billing system.
ExtlTaxExmpEndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date until which the tax exemption is valid.
ExtlTaxExmpPercentage
Type
percent
Properties
Create, Filter, Nillable, Sort, Update
Description
Tax exemption percentage the account is eligible for.
ExtlTaxExmpStartDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date from which the tax exemption is valid.
ExtlTaxExmpType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the type of tax exemption the account is eligible for.
Possible values are:
  • Energy Tax Incentives
  • Lower Income Group
ExtlTaxIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The external tax identifier number for this customer.
IsAutopayEnabled
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the customer has opted for automatic payment.
The default value is false.
IsBillingHold
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether billing is suspended on this customer's account
The default value is false.
PrimaryBillAddr
Type
address
Properties
Filter, Nillable
Description
Address to which bills are to be sent
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the status of the customer billing account.
Possible values are:
  • Active
  • Inactive
  • Suspended
The default value is Active.
TmpBillingAddr
Type
address
Properties
Filter, Nillable
Description
The alternative address if the bill should not be sent to the customer's primary address
TmpBillingAddrEndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The end date when the alternate billing address should be used
TmpBillingAddrStartDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The start date when the alternate billing address should be used