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 Fields on Standard Objects
Salesforce Payments Objects in Billing
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
Payment Line Apply Input
Payment Line Unapply Input
Payment Run Batch Filter Criteria Input
Payment Batch Scheduler Input
Payment Scheduler Update Input
Posted Invoice List Write-Off Input
Posted Invoice Write-Off Input
Refund Line Apply 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 Line Input

Input representation of the details of the invoice lines to be credited.
JSON example
"invoiceLines": [
    {
      "invoiceLineId": "5TVR00000004SiqOBE",
      "amountToCredit": 100,
      "taxStrategy": "ManualOverride",
      "taxEffectiveDate": "2021-08-01T21:22:41.000Z",
      "taxes": [
        {
          "taxAmount": 15,
          "taxName": "abc",
          "taxCode": "taxCode",
          "taxRate": 7
        }
      ],
      "addresses": {
        "billingAddress": {
          "street": "1 Market St #300",
          "city": "San Francisco",
          "state": "CA",
          "country": "US",
          "postalCode": "94105",
          "latitude": "37.789901",
          "longitude": "-122.396923"
        },
        "shippingAddress": {
          "street": "415 Mission St",
          "city": "San Francisco",
          "state": "CA",
          "country": "US",
          "postalCode": "94105",
          "latitude": "37.789901",
          "longitude": "-122.396923"
        }
      }
    },
    {
      "invoiceLineId": "5TVR00000004SiqOAE",
      "amountToCredit": 200,
      "taxStrategy": "CopyFromInvoiceLine"
    }
  ]
Properties
Name Type Description Required or Optional Available Version
addresses Credit Memo Addresses Input[]

Addresses to be created manually for this invoice line and the overridden tax lines. These addresses are only applicable if this invoice line is using the ManualOverride tax strategy.

 Optional 62.0
amountTo​Credit Double

Amount to be credited from this invoice line.

 Required 62.0
invoice​LineId String

ID of the invoice line record to be credited. The invoice line ID must be related to the invoice ID specified in the API request.

 Required 62.0
isTaxOnly​Credit Boolean

Indicates whether the applicable tax amount is credited for the charge or adjustment amount (true), or the applicable tax amount is credited along with the charge or adjustment amount (false). The default value is false.

 Optional 62.0
taxEffective​Date String

Date when the tax takes effect and the invoice line is credited.

 Optional 62.0
tax​Strategy String

Tax strategy for crediting the invoice line. This tax strategy takes precedence over the taxStrategy property value specified in the Credit Invoice Input. Valid values are:

  • Ignore—Specifies that the creation of tax lines must be ignored.
  • ManualOverride—Specifies that the provided tax values must be considered for taxes.
  • CopyFromInvoiceLine—Specifies that tax values must be copied from the invoice line.
  • Calculate—Specifies that tax must be calculated by using the API.
 Optional 62.0
taxes Credit Invoice Line Tax Input[]

List of tax lines to be created manually for this invoice line.

 Required if the taxStrategy property value is ManualOverride. 62.0