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
AccountingPeriod
BillingBatchScheduler
BillingBatchFilterCriteria
BillingMilestonePlan
BillingMilestonePlanItem
BillingPeriodItem
BillingPolicy
BillingSchedule
BillingScheduleGroup
BillingTreatment
BillingTreatmentItem
BsgRelationship
CreditMemo
CreditMemoAddressGroup
CreditMemoInvApplication
CreditMemoLine
CreditMemoLineInvoiceLine
CreditMemoLineTax
GeneralLedgerAccount
GeneralLedgerAcctAsgntRule
InvBatchDraftToPostedRun
Invoice
InvoiceAddressGroup
InvoiceBatchRun
InvoiceBatchRunCriteria
InvoiceBatchRunRecovery
InvoiceDocument
InvoiceLine
InvoiceLineRelationship
InvoiceLineTax
LegalEntity
LegalEntyAccountingPeriod
PaymentBatchRun
PaymentLineInvoiceLine
PaymentSchedule
PaymentSchedulePolicy
PaymentScheduleTreatment
PaymentScheduleTreatmentDtl
PymtSchdDistributionMethod
PaymentScheduleItem
PaymentTerm
PaymentTermItem
RevenueTransactionErrorLog
TaxEngine
TaxEngineProvider
TaxPolicy
TaxTreatment
Billing Fields on Standard Objects
Salesforce Payments Objects in Billing
Billing Platform Events
Billing Standard Invocable Actions
Billing Business APIs
Billing Apex Reference
Billing Metadata API Types
Revenue Cloud Associated Objects
PDF

Invoice

Represents information about a financial document describing the total amount a buyer must pay for provided products or services. This object is available in API version 62.0 and later.

Supported Calls

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

Special Access Rules

You need the Billing Operations User permission set to access this object.

Fields

Field Details
Balance
Type
currency
Properties
Filter, Nillable, Sort
Description
The outstanding balance of an invoice. The balance is equal to the invoice’s total amount with tax, excluding payments and adjustments.
BillToContactId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The bill to contact ID of the account that's related to an invoice.
This field is a relationship field.
Relationship Name
BillToContact
Refers To
Contact
BillingAccountId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
Required. The ID of the customer account related to an invoice.
This field is a relationship field.
Relationship Name
BillingAccount
Refers To
Account
CorpCrcyCnvTotAmtWithTax
Type
double
Properties
Filter, Nillable, Sort, Update
Description
The sum of the total amount with tax on the related invoice lines in corporate currency. Available in API version 63.0 and later.
CorporateCurrencyCvsnDate
Type
date
Properties
Filter, Group, Nillable, Sort, Update
Description
The date on which the invoice's total amount with tax was converted to the corporate currency. Available in API version 63.0 and later.
CorporateCurrencyCvsnRate
Type
double
Properties
Filter, Nillable, Sort, Update
Description
The exchange rate that's used to convert invoice's total amount with tax to the corporate currency. Available in API version 63.0 and later.
CorporateCurrencyIsoCode
Type
string
Properties
Filter, Group, Nillable, Sort, Update
Description
The currency ISO code of the corporate currency. Available in API version 63.0 and later.
DaysInvoiceOpen
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of days from the day an invoice was created to the day it was paid.
This field is a calculated field.
DaysInvoiceOverdue
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of days since the date when the payment for an invoice was due.
This field is a calculated field.
Description
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Additional details about the invoice.
DocumentNumber
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Required. An auto-generated number identifying an invoice.
DueDate
Type
date
Properties
Create, Filter, Group, Sort, Update
Description
Required. The date by when the customer must pay an invoice.
FullSettlementDate
Type
date
Properties
Filter, Group, Nillable, Sort
Description
The date when the customer has paid an invoice in full.
InvBatchDraftToPostedRunId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the invoice batch to posted run record that generated a posted invoice from a draft invoice.
This field is a relationship field.
Relationship Name
InvBatchDraftToPostedRun
Refers To
InvBatchDraftToPostedRun
InvoiceBatchRunId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the invoice batch run record that generated an invoice.
This field is a relationship field.
Relationship Name
InvoiceBatchRun
Refers To
InvoiceBatchRun
InvoiceDate
Type
date
Properties
Create, Filter, Group, Sort, Update
Description
Required. The date when an invoice was posted. The payment term's net is added to this date to calculate the invoice's due date. For example, an invoice with an invoice date of 04/01 and the related payment term's period as 30 days has a due date of 05/01.
InvoiceLockedDateTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time at which an invoice is locked.
InvoiceNumber
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Required. The user-specified reference number for the invoice.
IsBillingScheduleGroupSkipped
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the invoice is generated from a billing transaction directly and if the billing schedule group wasn't created for the transaction (true), or if the invoice is generated from the billing schedule group that was created for the transaction (false).
The default value is false. Available in API version 63.0 and later.
IsInvoiceLocked
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort, Update
Description
Required. Indicates whether an invoice is locked for editing or not (true) or not (false).
The default value is false.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed an invoice 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 an invoice record. If this value is null, it’s possible that the user only accessed the invoice record or a related list view (LastReferencedDate), but not viewed the invoice record itself.
NetCreditsApplied
Type
currency
Properties
Filter, Nillable, Sort
Description
The net credits applied to an invoice. This amount is calculated by subtracting the sum of all the unapplied lines from the sum of all the applied lines.
This field is a calculated field.
NetPaymentsApplied
Type
currency
Properties
Filter, Nillable, Sort
Description
The net payments applied to an invoice. This field is visible from API version 62.0 but can only be used from API version 64.0 and later with the Revenue Cloud Billing license.
This field is a calculated field.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Required. The ID of the user who owns an Invoice record.
This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
Group, User
PaymentExclusionReason
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The reason for skipping the creation of payment schedules and payment schedule items for the invoice. Available in API version 64.0 and later with the Revenue Cloud Billing license.
PaymentTermId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The payment term used for an invoice.
This field is a relationship field.
Relationship Name
PaymentTerm
Refers To
PaymentTerm
PostedDate
Type
date
Properties
Filter, Group, Nillable, Sort
Description
The date when an invoice was posted.
ReferenceEntityId
Type
reference
Properties
Filter, Group, Nillable, Sort, Update
Description
The ID of the Order record or Credit Memo record that created an invoice.
This field is a polymorphic relationship field.
Relationship Name
ReferenceEntity
Refers To
CreditMemo, Order
SavedPaymentMethodId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the Saved Payment Method record that's used for the invoice. Available in API version 64.0 and later with the Revenue Cloud Billing license.
This field is a relationship field.
Relationship Name
SavedPaymentMethod
Refers To
SavedPaymentMethod
SettlementLevel
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The level at which the credit was applied.
Valid values are:
  • Invoice
  • InvoiceLine
SettlementStatus
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The status of an invoice's payment.
Valid values are:
  • Not Applicable
  • Not Settled
  • Partially Settled
  • Settled
Status
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Required. The status of an invoice.
Valid values are:
  • Canceled— Indicates that the invoice was generated and later canceled.
  • Draft— Indicates that the invoice is a draft.
  • Draft In Progress— Indicates that the draft invoice is in progress.
  • Error— Indicates that an error occurred when processing the invoice.
  • Pending— Indicates that the invoice is being processed.
  • Posted— Indicates that the invoice has been generated and sent to the customer.
  • Posting In Progress—Indicates that the invoice posting is in progress.
  • Void In Progress—Indicates that the invoice is pending a status change.
  • Voided—The invoice’s status after the API successfully voids the invoice.
TotalAdjustmentAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of the invoice’s adjustment line amounts.
This field is a calculated field.
TotalAdjustmentAmountWithTax
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of the invoice’s adjustment line amounts, including tax.
TotalAdjustmentTaxAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The total amount of tax applied to the invoice line's adjustment lines.
TotalAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of the total amount on the invoice’s lines.
This field is a calculated field.
TotalAmountWithTax
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of the total amount with tax on the invoice’s lines.
This field is a calculated field.
TotalChargeAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of the amount fields on the invoice's charge-type invoice lines.
This field is a calculated field.
TotalChargeAmountWithTax
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of the amount fields on the invoice's charge-type invoice lines, including tax.
TotalChargeTaxAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The total amount of tax applied to the invoice's charge lines.
TotalConvertedNegAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of all negative invoice lines that were converted to a credit memo. For example, if one negative invoice line was for -$10 and one was for -$15, the total amount that’s converted to a credit memo is -$25.
This field is a calculated field.
TotalTaxAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of the tax amount on the invoice lines.
This field is a calculated field.
UniqueIdentifier
Type
string
Properties
Filter, Group, idLookup, Nillable, Sort
Description
The unique identifier of an externally ingested invoice that's used to ensure that duplicate invoices aren't inserted. Available in API version 63.0 and later.
WriteOffStatus
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The status of the invoice write-off request.
This field is unique within your organization.
Valid values are:
  • Completed
  • Failed
  • InProgress
Available in API version 64.0 and later. This field is available in API version 64.0 and later with the Revenue Cloud Billing license.
WriteOffTotalChargeAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The total charge amount of the invoice that's written off.
This field is unique within your organization. This field is available in API version 64.0 and later with the Revenue Cloud Billing license.
WriteOffTotalTaxAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The total tax amount of the invoice that's written off.
This field is unique within your organization. This field is available in API version 64.0 and later with the Revenue Cloud Billing license.

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.

InvoiceFeed
Feed tracking is available for the object.
InvoiceHistory
History is available for tracked fields of the object.
InvoiceShare
Sharing is available for the object.