Newer Version Available

This content describes an older version of this product. View Latest

blng__Invoice__c

Represents a financial document describing the total amount a buyer must pay for provided goods or services.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Supported Calls

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

Fields

Field Details
CurrencyIsoCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The three-letter ISO 4217 currency code associated with the invoice when multiple currencies are enabled.
Custom_Lock__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies whether the invoice is locked or unlocked.
Valid values are:
  • Locked
  • Unlocked
The default value is Unlocked.
LastActivityDate
Type
date
Properties
Filter, Group, Nillable, Sort
Description
The timestamp of when a user had last associated a task or event action with the invoice.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp of when the current user had last accessed the invoice, or a record or list view related to the invoice.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when a user last viewed this record, a record related to this record, or a list view. If this value is null, it's possible the user accessed this record or list view (LastReferencedDate) but didn't view it.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name of the invoice.
blng__ARStatus__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Shows whether the invoice has been credited, or canceled and rebilled. Valid values are:
  • Cancel and Rebill
  • Credited
blng__Account__c
Type
reference
Properties
Create, Filter, Group, Sort
Description
The invoice's parent account that’s inherited from the order product. This is a relationship field.
Relationship Name
blng__Account__r
Relationship Type
Master-detail
Refers To
Account (the master object)
blng__Action__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies whether a user has credited the invoice by either selecting the Cancel and Rebill button or the Credit button.
Valid values are:
  • Cancel and Rebill
  • Credit
blng__Balance__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of balances of all the related invoice lines. This amount is equal to the invoice’s total amount with tax, after deducting the payments and adjustments made. This is a calculated field.
blng__BaseCurrencyAmount__c
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
If you have currency conversion requirements, you can define your base currency amount here. When you export your data, you can use this value in your conversions.
blng__BaseCurrencyFXDate__c
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
If you have currency conversion requirements, you can define your base currency foreign exchange (FX) date here. When you export your data, you can use this value in your conversions.
blng__BaseCurrencyFXRate__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
If you have currency conversion requirements, you can define your base currency FX rate here. When you export your data, you can use this value in your conversions.
blng__BaseCurrency__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
If you have currency conversion requirements, you can define your base currency here.
blng__BillToContact__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The user who receives information about the invoice. This is a relationship field.
Relationship Name
blng__BillToContact__r
Relationship Type
Lookup
Refers To
Contact
blng__CorrectiveAction__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
When this field has a value of Action Required, the invoice is locked from receiving payments until the issue defined in the Last Payment Run Processing Message field is resolved.
blng__Credits__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of credit notes allocated against the invoice and its invoice lines. Sum of all credit note amounts applied to this invoice. This is a calculated field.
blng__DaysOutstanding__c
Type
double
Properties
Filter, Nillable, Sort
Description
The number of days past the invoice due date.
blng__DebitPayments__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of payments made to debit notes allocated against the invoice and its invoice lines. This is a calculated field.
blng__Debits__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of debit notes allocated against the invoice and its invoice lines. This is a calculated field.
blng__DeclinedPaymentRunCount__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Salesforce Billing doesn't populate this field by default. You can add your own customization to it when you want to track the number of times a payment run that targets the invoice has been unable to pay it.
blng__DefaultPaymentType__c
Type
string
Properties
Filter, Nillable, Sort
Description
Used in payment runs. A payment run picks up an invoice when the run and the invoice have matching Default Payment Type values. This is a calculated field.
blng__DueDate__c
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date by which customers must pay their invoice. This field is provided for users who want to add their own due date and collections features for AR and AP.
blng__ImpactAmount__c
Type
currency
Properties
Filter, Nillable, Sort
Description
Inherits the value of the invoice’s total amount. This field is provided for users who must monitor impact amounts separately as part of their billing and collections processes. This is a calculated field.
blng__InvoiceDate__c
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date the invoice was created either by the bill now process or an invoice run.
blng__InvoiceLocked__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the invoice is locked (true) or not (false). Before unlocking it, check whether a payment has already been created against this invoice. The default value is false.
blng__InvoicePostedDate__c
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date the invoice was posted.
blng__InvoiceRunCreatedBy__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the invoice run that created the invoice. This is a relationship field.
Relationship Name
blng__InvoiceRunCreatedBy__r
Relationship Type
Lookup
Refers To
blng__InvoiceRun__c
blng__InvoiceStatus__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The state of the invoice. Valid values are:
  • Cancelled
  • Draft
  • Error
  • Initiated
  • Post In progress
  • Posted
  • Rebilled
The default value is Draft.
blng__LastPaymentRunId__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the most recent payment run that evaluated the invoice for payment. This is a relationship field.
Relationship Name
blng__LastPaymentRunId__r
Relationship Type
Lookup
Refers To
blng__PaymentRun__c
blng__LastPaymentRunProcessingMessage__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
If a payment run that targeted the invoice encountered an issue, this field shows information on how to correct the issue and unlock the invoice for receiving payments.
blng__NegativeLineConversion__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of all Negative Line Conversion fields on the invoice’s invoice lines. This is a calculated field.
blng__Notes__c
Type
textarea
Properties
Create, Nillable, Update
Description
Specifies any additional notes and information from a user.
blng__NumberOfInvoiceLines__c
Type
double
Properties
Filter, Nillable, Sort
Description
The total number of invoice lines. This is a calculated field.
blng__Order__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Populated only when Bill Now is used to create the invoice, or during an invoice run if the order product Invoice Group field has a value of Order. This is a relationship field.
Relationship Name
blng__Order__r
Relationship Type
Lookup
Refers To
Order
blng__PaymentBatch__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
If a payment scheduler has a payment batch value, the payment run evaluates only invoices with matching payment batch values. If this field is null, payment runs evaluate the invoice only if the payment run's batch is also null.
blng__PaymentMethod__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Payment methods store Automated Clearing House (ACH) or credit card details for a customer, and the payment gateway that accepts payments. This is a relationship field.
Relationship Name
blng__PaymentMethod__r
Relationship Type
Lookup
Refers To
blng__PaymentMethod__c
blng__PaymentProcessStatus__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The status of the payment process. Valid values are:
  • Completed
  • Failed
  • Processing
  • Started
blng__PaymentRunId__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the payment run that evaluated and made payment against the invoice. This is a relationship field.
Relationship Name
blng__PaymentRunId__r
Relationship Type
Lookup
Refers To
blng__PaymentRun__c
blng__PaymentRunProcessingMessage__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
This field doesn't have any functionality by default.
blng__PaymentStatus__c
Type
string
Properties
Filter, Nillable, Sort
Description
A formula field that shows Paid when the invoice balance is zero (0). If payments are applied but there’s still a balance, the formula returns Partially Paid. If there are no payments applied, then the field shows Unpaid. If only credit notes are allocated to an invoice and the balance is still positive, the payment status remains Unpaid. Only applying payments to the invoice can change the status to Partially Paid. If this is a requirement, create a custom field. This is a calculated field.
blng__PaymentsAgainstInvoiceLines__c
Type
currency
Properties
Filter, Nillable, Sort
Description
Net amount of payments against the invoice line in the invoice. This is a calculated field.
blng__PaymentsAgainstInvoice__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of payment amount allocated to the invoice header. This field is used only when not using line level allocations. This is a calculated field.
blng__Payments__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The number of payments made against this invoice. This is a calculated field.
blng__RefundsAgainstInvoiceLines__c
Type
currency
Properties
Filter, Nillable, Sort
Description
Cancellations of previous allocations to the invoice lines. This is a calculated field.
blng__RefundsAgainstInvoice__c
Type
currency
Properties
Filter, Nillable, Sort
Description
Cancellations of previous allocations to the invoice. This is a calculated field.
blng__StatusFlag__c
Type
string
Properties
Filter, Nillable, Sort
Description
Specifies the status of the invoice, with different color codes representing each status. Valid values are:
  • Orange— Active with balance
  • Green— No balance due
  • White— Canceled
This is a calculated field.
blng__Subtotal__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The amount to settle on this invoice, excluding tax. This is a calculated field.
blng__TargetDate__c
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The earliest date for invoicing.
blng__TaxAmount__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of all taxes for this invoice. This is a calculated field.
blng__TaxErrorMessage__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The notification about the issue related to taxes on the invoice.
blng__TaxErrors__c
Type
double
Properties
Filter, Nillable, Sort
Description
Specifies a problem with the tax details associated with the invoice. This is a calculated field.
blng__TaxStatus__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The type of tax treatment this invoice qualifies for. Valid values are:
  • Cancelled
  • Completed
  • Error
  • Posted
  • Queued
blng__TotalAmount__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The total amount to be invoiced, including tax. This is a calculated field.
blng__UniqueId__c
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
The unique identification number associated with this invoice. This field has unique set to true.This field is unique within your organization.