Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

PaymentInstruction

Represents a payment instruction that specifies an amount to be paid using a particular payment instrument. Contains payment status information and links to the source of the instruction and the payment instrument to be used.

Supported Calls

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

Special Access Rules

This object is available only if Outbound Payments is enabled in your org and users have access to Outbound Payments.

Fields

Field	Details
Amount	Type currency Properties Create, Filter, Sort, Update Description The payment amount for this instruction.
ExpectedPaymentDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date the payment is expected to be complete.
InstructionIdentifier	Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description An external identifier for the payment instruction, assigned by the external payment system.
InstructionSourceId	Type reference Properties Create, Filter, Group, Nillable, Sort Description Polymorphic foreign key linking to PaymentRequest, BenefitDisbursement, or Claim. This field is a polymorphic relationship field. Relationship Name InstructionSource Refers To BenefitDisbursement, Claim, PaymentRequest
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly.
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description The name of the payment instruction.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of this record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User
PaymentInstrumentId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The payment instrument used for this payment instruction. This field is a relationship field. Relationship Name PaymentInstrument Refers To PaymentInstrument
PaymentStatus	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Payment status calculated from Amount and PaidAmount comparison. Automatically mirrored to source entity. Possible values are: `NotPaid` `Overpaid` `Paid` `Partial`
ProcessedAmount	Type currency Properties Filter, Nillable, Sort Description The sum of all PaymentInstructionPayment amounts. This field is a calculated field.
Type	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Type of payment instruction. For outbound payments, the type must be set to Outbound. Possible values are: `Outbound`

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.

PaymentInstructionHistory: History is available for tracked fields of the object.
PaymentInstructionShare: Sharing is available for the object.

Public Sector Developer Guide

PaymentInstruction

Supported Calls

Special Access Rules

Fields

Associated Objects