Refund Line Apply (POST)

Make a refund transaction against a payment.

Resource 

 
1/commerce/billing/refunds/{refundId}/actions/apply

Resource Example 

 
1https://{yourInstance}.salesforce.com/services/data/v68.0/commerce/billing/refunds/{0cbVc0000000G4nIAE}/actions/apply

Available Version 

64.0

HTTP Methods 

POST

Path Parameter for POST 
NameTypeDescriptionRequired or OptionalAvailable Version
refundIdStringID of the refund record.Required64.0

Request Body for POST 

JSON Example

1{
2  "appliedToId": "0aQR00000004ZkKMAU",
3  "amount": 10,
4  "effectiveDate": "2020-08-11T07:53:15.000Z",
5  "comments": "Payment application."
6}

Properties

NameTypeDescriptionRequired or OptionalAvailable Version
amountDoubleAmount to refund.Required64.0
appliedToIdStringID of a payment or credit memo record. The refund is applied to this object.Required64.0
commentsStringAdditional details of the refund request.Optional64.0
effectiveDateStringDate from when the refund is in effect.Optional64.0

Response Body for POST 

Refund Line Apply

Get Started with Revenue Management Developer Resources
Revenue Management Settings
Revenue Management Deployment
Product Catalog Management
Salesforce Pricing
Rate Management
Product Configurator
Transaction Management
Advanced Approvals
Dynamic Revenue Orchestrator
Usage Management
Billing
Billing Standard Objects
Billing Fields on Standard Objects
Salesforce Payments Objects in Billing
Billing Platform Events
Billing Standard Invocable Actions
Billing Business APIs
Billing Business API Limits
Resources
Sequence Gap Reconciliation (POST)
Sequence Assignment (POST)
Batch Invoices Document Generation (POST)
Batch Invoices Document Generation Retry (POST)
Batch Invoices Draft to Posted Status (POST)
Batch Invoice Scheduler (POST, PUT)
Batch Payment Scheduler (POST)
Billing Arrangement (GET)
Billing Schedule Recovery List (POST)
Composite Collection Plan Creation (POST)
Create Billing Schedules for Orders (POST)
Create Sequence Policy (POST)
Create Standalone Billing Schedules (POST)
Create and Apply Credit Memo (POST)
Apply Credit Memo (POST)
Unapply Credit Memo (POST)
Apply Credit Memo Line (POST)
Unapply Credit Memo Line (POST)
Generate On-Demand Invoice Document (POST)
Generate Account Statement (POST)
Invoice Creation (POST)
Invoice Draft to Posted Status (POST)
Invoice Ingestion (POST)
Invoice Estimated Tax Calculation (POST)
Invoice Preview (POST)
Invoice Run Recovery (POST)
Negative Invoice Lines to Credit Conversion (POST)
Payment Line Apply (POST)
Payment Line Unapply (POST)
Payment Scheduler Update (PATCH)
Post a Draft Memo (POST)
Rules Application (POST)
Posted Invoice List Write-Off (POST)
Void a Posted Invoice (POST)
Refund Line Apply (POST)
Send Emails for Posted Invoices (POST)
Resume Billing (POST)
Suspend Billing (POST)
Standalone Credit Memo (POST)
Billing Checkout (POST)
Tax Calculation (POST)
Update Sequence Policy (PATCH)
Void Posted Credit Memo (POST)
Refund Credit Memo (POST)
Request Bodies
Response Bodies
Billing Apex Reference
Billing Metadata API Types
Revenue Management Associated Objects
Previous Versions