Surcharge

Represents the details about a surcharge calculation. This object is available in API version 63.0 and later.

Supported Calls

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

Fields

Amount

  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The surcharge as a flat amount.

CalculationType

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The type of calculation or process used to determine the surcharge.
  • Possible values:
    • Amount
    • Expression Set
    • Percentage

Code

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Description: The unique string that represents the surcharge.

    Available in API version 66.0 and later.

Description

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The description of the surcharge.

EffectiveFromDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The date when the surcharge becomes active.

EffectiveToDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The date when the surcharge becomes inactive.

IsActive

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the surcharge is active (true) or not (false).
  • Default value: false

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, it’s possible that this record was referenced (LastReferencedDate) and not viewed.

Name

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The name of the surcharge.

OwnerId

  • Type: reference
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: The ID of the owner of this record.

    This field is a polymorphic relationship field.

  • Relationship Name: Owner
  • Refers To: Group, User

ProcedureId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The name of the expression set or integration procedure that's used to calculate the surcharge.

    This field is a relationship field.

  • Relationship Name: Procedure
  • Refers To: ExpressionSet

Rate

  • Type: percent
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The surcharge amount as a percentage.

SurchargeType

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The type of the surcharge.
  • Possible values:
    • Fee —Available in API version 66.0 and later.
    • Tax

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.

SurchargeHistory
History is available for tracked fields of the object in API version 64.0 and later.
SurchargeOwnerSharingRule
Sharing rules are available for the object in API version 64.0 and later.
SurchargeShare
Sharing is available for the object in API version 64.0 and later.