Newer Version Available

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

Invoice

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

Users can edit non-posted invoices. Posted invoices can’t be deleted. Once an invoice is posted, users can make payments against it to reduce its balance.

Supported Calls

describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search()

Special Access Rules

To access these entities, your org must have a Salesforce Order Management license. These entities are available only in Lightning Experience.

Fields

Field Details
Balance
Type
currency
Properties
Filter, Nillable, Sort
Description
The outstanding balance for this invoice. Equal to the invoice’s total amount with tax, ignoring payments and adjustments.
BillToContactId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Inherited from the account’s Bill to Account.
BillingAccountId
Type
reference
Properties
Filter, Group, Sort
Description
The customer account for this invoice.
Description
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Users can add more information about this invoice. Maximum of 1000 characters.
DocumentNumber
Type
string
Properties
Filter, Group, Nillable, Sort
Description
System-generated number that is used to organize financial documents. Can be sequential or random.
DueDate
Type
date
Properties
Filter, Group, Sort
Description
The customer must pay the invoice by the due date. Unpaid invoices past the due date may be sent to collections.
InvoiceDate
Type
date
Properties
Filter, Group, Sort
Description
The date that the invoice was posted. Used with payment terms to determine the invoice’s DueDate. For example, an invoice with an InvoiceDate of 04/01 and Net 30 payment terms would have a DueDate of 05/01.
InvoiceNumber
Type
string
Properties
Filter, Group, Nillable, Sort
Description
System-created unique ID for this invoice.
OwnerId
Type
reference
Properties
Filter, Group, Sort
Description
The user who owns an invoice record.
ReferenceEntityId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the order or order summary that created this invoice.
Status
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The state of the invoice.
Possible values are:
  • Canceled: Reserved for future use.
  • Draft: Reserved for future use.
  • ErrorPosting: Reserved for future use.
  • Pending: Reserved for future use.
  • Posted: Reserved for future use.
TotalAdjustmentAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of the invoice’s adjustment line amounts.
TotalAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum TotalAmount values on the invoice’s lines.
TotalAmountWithTax
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of TotalAmountWithTax values on the invoice’s lines.
TotalChargeAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of the invoice’s charges.
TotalTaxAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of TaxAmount values on the invoice lines.