PaymentCreditLinePayment

A payment credit line payment. 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
Amount
Type
currency
Properties
Create, Filter, Sort
Description
Amount to apply to or unapply from the payment to the credit.
This is a required field.
AppliedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Date payment was applied. Can be the current date or a provided date.
AssociatedAccountId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
ID of the customer account.
This field is a relationship field.
Relationship Name
AssociatedAccount
Refers To
Account
AssociatedLineId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
ID of the associated line.
This field is a relationship field.
Relationship Name
AssociatedLine
Refers To
PaymentCreditLinePayment
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.
Description
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Description regarding the payment credit.
HasBeenUnapplied
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the refund line record with type Applied has been unapplied. Not applicable for a refund line record with type Unapplied.
This is a required field.
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.
PaymentCreditId
Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the payment credit.
This field is a relationship field.
This is a required field.
Relationship Name
PaymentCredit
Refers To
PaymentCredit
PaymentCreditLine PaymentNumber
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Number of the payment credit line payment. This field is automatically generated.
Example: PCLP-{000000000}.
PaymentId
Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the applied payment credit.
This field is a relationship field.
Relationship Name
Payment
Relationship Type
Master-detail
Refers To
Payment (the master object)
Type
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description
Payment credit type. This is a required field.
Possible values are:
  • Applied
  • Unapplied
UnappliedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Date payment was unapplied. Can be the current date or a provided date.