PaymentCredit

Tracks the amount of money returned to the customer. The return can be a store credit, a gift card, or another type of credit. It’s linked to the original payment record and includes the total credit amount issued.

Introduced in API version 65.0.

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

  • This object is only available in Salesforce Order Management orgs or if the B2B Commerce or D2C Commerce license is enabled. Users require the PaymentCredit and PaymentPlatform permission sets.
  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    The account of the customer who made the payment.

    This field is a relationship field.

    This is a required field.

  • Relationship name: Account

  • Relationship type: relationship

  • Refers to: Account

  • Type: currency

  • Properties: Create, Filter, Sort

  • Description:

    The amount to be credited.

    This is a required field.

  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Balance of payment credits (NetApplied - TotalCredit TransactionAmount - TotalCredit PendingTransactionAmount).
  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Provide additional details about the payment credit transaction.
  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    ID of the credit memo associated with the payment credit.

    This field is a relationship field.

  • Relationship name: CreditMemo

  • Relationship type: relationship

  • Refers to: CreditMemo

  • Type: picklist

  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update

  • Description:

    Credit types available.

    This is a dynamic picklist that the user can define.

  • Possible values:

    • Credit — Credit
    • Gift Card — Gift Card
    • Gift Certificate — Gift Certificate
  • Type: picklist

  • Properties: Create, Filter, Group, Restricted picklist, Sort

  • Description:

    A static enum showing the credit category type.

    Possible value is:

  • Possible values:

    • Credit — Credit
  • Type: datetime
  • Properties: Create, Filter, Sort, Update
  • Description: Effective date of the payment credit.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Total of all credit amounts apllied for this payment credit (TotalCreditApplied - TotalCreditUnapplied).
  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    ID of the order payment summary.

    This field is a relationship field.

  • Relationship name: OrderPaymentSummary

  • Relationship type: relationship

  • Refers to: OrderPaymentSummary

  • Type: string

  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort

  • Description:

    ID of the payment credit record. This field is automatically generated.

    Example: PC-{000000000}.

  • Type: reference

  • Properties: Create, Filter, Group, Sort, Update

  • Description:

    ID of the payment associated with the payment credit.

    This field is a relationship field.

  • Relationship name: Payment

  • Relationship type: relationship

  • Refers to: Payment

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    ID of the return order associated with the payment credit.

    This field is a relationship field.

  • Relationship name: ReturnOrder

  • Relationship type: relationship

  • Refers to: ReturnOrder

  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Sum of all applied amounts from the payment credit line payment.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Sum of pending payment credits.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Sum of processed payment credits.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Sum of all the unapplied amounts from the payment credit line payment.