Newer Version Available

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

BalanceAdjustmentRequest

The request to create a financial adjustment in a backend billing system. Adjustments requests can be for either debit or credit amounts. Often used to give the customer a goodwill gesture. 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
Amount
Type
currency
Properties
Create, Filter, Sort, Update
Description
The monetary amount of balance adjustment being requested
ApprovedById
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The user associated with approving the balance adjustment request
This field is a relationship field.
Relationship Name
ApprovedBy
Refers To
User
ApprovedOn
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date the balance adjustment request was approved
BillingAccountId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The billing profile associated with the balance adjustment request
This field is a relationship field.
Relationship Name
BillingAccount
Refers To
BillingAccount
BlockReason
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the reason why the balance adjustment request is placed on hold from further processing
IsBlocked
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the balance adjustment request is placed on hold from further processing
The default value is false.
Reason
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The reason that the balance adjustment is requested
Status
Type
picklist
Properties
Create, Filter, Group, Sort, Update
Description
Specifies the current status of the balance adjustment request
Possible values are:
  • Generated
  • Processed
Type
Type
picklist
Properties
Create, Filter, Group, Sort, Update
Description
Specifies the type of balance adjustment requested
Possible values are:
  • Credit
  • Debit