Actions Developer Guide

Introducing Actions
Action Objects
Apex Actions
Assign Enablement Program
Apply Case Classification Recommendations
B2B and D2C Commerce Actions
Cancel Approval Submission Action
Change Order Summary Preview
Change Order Summary Submit
Commerce Checkout Flow Actions
Convert Base64 Speech to Text Action
Create Service Document Actions
Create Service Report Actions
Custom Notification Actions
Deploy Data Kit Components Action
Email Alert Actions
Einstein Bots Actions
Exit Individuals from a Flow Action
Explore Conversation Actions
Flow Actions
Generate Order Summary Action
Generate Work Orders Actions
Get Assessment Response Summary
Get Conversation Intelligence Action
Get Conversation Transcript Action
Get Data Graph Data By Lookup
Get Data Graph Metadata
Knowledge Actions
Lead Action
Live Message Notification Actions
Omni-Channel Action
Apply Payment Action
Payment Sale Action
Perform Survey Sentiment Analysis
PlatformAction
Post to Chatter Actions
Preview Cart to Exchange Order
Prompt Template Actions
Quick Actions
Reassign Approval Work Item Action
Recall Approval Submission Action
Refresh Metric Actions
Review Approval Work Item Action
Sales Engagement Actions
Salesforce Omnichannel Inventory Actions
Salesforce Order Management Actions
Send Conversation Messages Actions
Send Notification Actions
Session-Based Permission Set Actions
Simple Email Actions
Speech to Text Action
Submit Exchange Order
Submit for Approval Actions
Survey Invitation Actions
Text to Speech Action (Beta)
Work Plan and Work Step Actions
PDF

Apply Payment Action

Applies a payment record to an invoice header by creating a PaymentLineInvoice record with a type of Applied.

To access Commerce Payments resources, you need the following permissions: Salesforce Order Management License or Salesforce B2B Commerce License, and PaymentsAPIUser user permission. This permission is available with the Salesforce Order Management or B2B Commerce License. Your Salesforce admin assigns it to your user profile.

This object is available in API version 54.0 and later.

Supported REST HTTP Methods

URI: /services/data/v54.0/actions/standard/applyPayment

Formats: JSON

HTTP Methods: POST

Authentication: Authorization: Bearer token

Inputs

Input Type Description
amount number Required. The amount to be applied to the invoice header.
appliedToId ID Required. The ID of the invoice that receives the payment.
associatedAccountId ID Optional. The ID of the account that contains the invoice.
comments String Optional comments for more information about the payment application.
effectiveDate datetime Optional. The date that the payment takes effect on the invoice.
paymentId string Required. The payment that's applied to the invoice. The application is represented by the PaymentLineInvoice created for a successful action.

Outputs

Output Type Description
appliedDate datetime The date that the payment was applied to the invoice header.
paymentLineInvoiceId ID Represents the application of the payment's amount to the invoice. Created after a successful action.