SustainabilityCredit

Represents information about the sustainability credits that are a part of a sustainability purchase. This object is available in API version 56.0 and later.

Supported Calls

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

Special Access Rules

Fields

Field Details
CostPerUnit
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The cost of the credits for each unit of emissions.
CrbnCreditProjectId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The carbon credit project that's associated with sustainability credit.
This field is a relationship field.
Relationship Name
CrbnCreditProject
Relationship Type
Lookup
Refers To
CrbnCreditProject
CreditsAllocated
Type
double
Properties
Filter, Nillable, Sort
Description
The credits that are allocated to the emissions inventory of the organization.
CreditsAvailable
Type
double
Properties
Filter, Nillable, Sort
Description
The credits that are available after allocation.
CreditsIssueDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when the credits were issued.
CreditsPurchased
Type
double
Properties
Create, Filter, Sort, Update
Description
The credits that are purchased by the organization.
CreditsRetiredDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when the credits are retired from the registry.
CreditsUnit
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
The unit of measure for the credits.
Possible values are:
  • TCO2E—tCO2e
The default value is TCO2E.
Description
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The description of the sustainability credit item.
ExternalIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The external identifier of the data that is imported for the carbon credit project.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name of the sustainability credit item.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the user who owns this record.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
PurchaseDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when the sustainability credits were purchased.
Status
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the status of the sustainability credit.
Possible values are:
  • HELD_WITH_REGISTRY—Held with Registry
  • RETIRED—Retired
SupplierId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the organization responsible for supplying the sustainability credits.
This field is a relationship field.
Relationship Name
Supplier
Relationship Type
Lookup
Refers To
Supplier
SustainabilityPurchaseId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The sustainability purchase record that's associated with the purchase of sustainability credits, such as carbon credits.
This field is a relationship field.
Relationship Name
SustainabilityPurchase
Relationship Type
Lookup
Refers To
SustainabilityPurchase
TotalCost
Type
currency
Properties
Filter, Nillable, Sort
Description
The total amount spent on the credits.
VintageYear
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The year when the sustainability credits were issued.

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.

SustainabilityCreditFeed
Feed tracking is available for the object.
SustainabilityCreditHistory
History is available for tracked fields of the object.
SustainabilityCreditShare
Sharing is available for the object.