Revenue Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Get Started with Revenue Cloud Developer Resources
Product Catalog Management
Salesforce Pricing
Product Configurator
Transaction Management
Usage Management
Rate Management
Dynamic Revenue Orchestrator
Billing
Billing Standard Objects
Billing Platform Events
Billing Standard Invocable Actions
Billing Business APIs
Billing Business API Limits
Resources
Request Bodies
Address Input
Addresses Input
Batch Invoice Filter Criteria Input
Batch Invoice Scheduler Input
Billing Schedule Recovery Input
Context-Aware Billing Schedule
Convert Negative Invoice Lines Input
Credit Invoice Input
Credit Invoice Line Input
Credit Invoice Line Tax Input
Credit Memo Addresses Input
Credit Memo Apply Input
Credit Memo Apply Application Input
Credit Memo Unapply Input
Credit Memo Line Apply Input
Credit Memo Line Application Input
Credit Memo Line Unapply Input
Customer Details Input
Frequency Cadence Options
Graph Record for Invoice Ingestion
Invoice Draft To Posted Input
Invoice Estimated Tax Calculation Input
Invoice Ingestion Input
Invoice Input for Ingestion
Invoice Input
Invoice Preview Input
Line Item Input
Resume Billing Input
Resume Billing Object Input
Seller Details Input
Standalone Credit Memo Charge Input
Standalone Credit Memo Input
Standalone Credit Memo Tax Input
Suspend Billing Input
Suspend Billing Object Input
Tax Calculation Input
Void Posted Invoice Input
Response Bodies
Billing Apex Reference
Billing Metadata API Types
Revenue Cloud Associated Objects
PDF

Credit Invoice Input

Input representation of the details of the request to create a credit memo.
JSON example
This example shows a sample request with the Calculate tax strategy.
{
  "type": "POSTED",
  "taxStrategy": "Calculate",
  "taxEffectiveDate": "2024-07-20",
  "effectiveDate": "2024-07-20",
  "description": "Credit Invoice",
  "invoiceLines": [
    {
      "invoiceLineId": "5TVR00000004SiqOBE",
      "amountToCredit": 5
    }
  ]
}
This example shows a sample request with the CopyFromInvoiceLine tax strategy.
{
  "type": "POSTED",
  "taxStrategy": "CopyFromInvoiceLine",
  "effectiveDate": "2020-05-22",
  "description": "Credit Invoice",
  "invoiceLines": [
    {
      "invoiceLineId": "5TVR00000004SiqOBE",
      "amountToCredit": "5",
      "taxStrategy": "CopyFromInvoiceLine"
    }
  ]
}
Properties
Name Type Description Required or Optional Available Version
description String

Description for the credit memo to be created.

 Optional 62.0
effective​Date String

Date when the credit memo takes effect.

 Optional 62.0
invoice​Lines Credit Invoice Line Input[]

List of the invoice lines to be credited. The invoice line IDs must be related to the invoice ID specified in the API request. If invoice lines aren’t specified, the API request results in an error.

 Required 62.0
taxEffective​Date String

Date when the tax takes effect to recalculate the taxes.

 Optional 62.0
tax​Strategy String

Tax strategy to be applied across invoice lines. You can override the tax strategy at the individual invoice line level or at the tax line level. Valid values are:

  • Ignore—Specifies that the creation of tax lines must be ignored.
  • CopyFromInvoiceLine—Specifies that tax values must be copied from the invoice line.
  • Calculate—Specifies that tax must be calculated by using the API.
 Required 62.0
type String

Type of credit memo to be created. Valid value is Posted.

 Optional 62.0