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. This object is available in API version 65.0 and later.

Supported Calls

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

Special Access Rules

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.

Fields

Field	Details
AccountId	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 Refers To Account
Amount	Type currency Properties Create, Filter, Sort Description The amount to be credited. This is a required field.
Balance	Type currency Properties Filter, Nillable, Sort Description Balance of payment credits (NetApplied - TotalCredit TransactionAmount - TotalCredit PendingTransactionAmount).
Comments	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Provide additional details about the payment credit transaction.
CreditMemoId	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 Refers To CreditMemo
CreditType	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 are: `Credit` `Gift Card` `Gift Certificate`
CreditTypeCategory	Type picklist Properties Filter, Group, Restricted picklist, Sort Description A static enum showing the credit category type. Possible value is: `Credit`
CurrencyIsoCode	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Contains the ISO code for any currency allowed by the organization. Possible values are: `EUR`—Euro `GBP`—British Pound `USD`—U.S. Dollar The default value is `USD`.
EffectiveDate	Type dateTime Properties Create, Filter, Sort, Update Description Effective date of the payment credit.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description Timestamp for when the current user last viewed a record related to this record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description 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.
NetApplied	Type currency Properties Filter, Nillable, Sort Description Total of all credit amounts apllied for this payment credit (TotalCreditApplied - TotalCreditUnapplied).
OrderPaymentSummaryId	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 Refers To OrderPaymentSummary
PaymentCreditNumber	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}.
PaymentId	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 Refers To Payment
ReturnOrderId	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 Refers To ReturnOrder
TotalApplied	Type currency Properties Filter, Nillable, Sort Description Sum of all applied amounts from the payment credit line payment.
TotalCreditPendingTxnAmt	Type currency Properties Filter, Nillable, Sort Description Sum of pending payment credits.
TotalCreditTxnAmt	Type currency Properties Filter, Nillable, Sort Description Sum of processed payment credits.
TotalUnapplied	Type currency Properties Filter, Nillable, Sort Description Sum of all the unapplied amounts from the payment credit line payment.