{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "associated_objects",
    "field_reference"
  ],
  "title": "Invoice - Data API",
  "description": "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.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "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, Update",
      "description": "Inherited from the account’s Bill to Account. This field is a relationship field.",
      "relationship_name": "BillToContact",
      "relationship_type": "Lookup",
      "refers_to": "Contact"
    },
    "BillingAccountId": {
      "type": "reference",
      "properties": "Filter, Group, Sort, Update",
      "description": "The customer account for this invoice. This field is a relationship field.",
      "relationship_name": "BillingAccount",
      "relationship_type": "Lookup",
      "refers_to": "Account"
    },
    "CurrencyIsoCode": {
      "type": "picklist",
      "properties": "Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "The three-letter ISO 4217 currency code associated with the invoice. The default value is USD. This field is available in API version 55.0 and later."
    },
    "DaysInvoiceOpen": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Number of days since the invoice was created before it was paid. This field is a calculated field. This field is available in API version 55.0 and later."
    },
    "DaysInvoiceOverdue": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Number of days since the date when payment was due. This field is a calculated field. This field is available in API version 55.0 and later."
    },
    "Description": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort, Update",
      "description": "Users can add more information about this invoice. Maximum of 1,000 characters."
    },
    "DocumentNumber": {
      "type": "string",
      "properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
      "description": "The system-generated number that is used to organize financial documents. The number can be sequential or random."
    },
    "DueDate": {
      "type": "date",
      "properties": "Filter, Group, Sort, Update",
      "description": "The customer must pay the invoice by the due date. Unpaid invoices past the due date can be sent to collections."
    },
    "FullSettlementDate": {
      "type": "date",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Date when the invoice is paid in full. This field is available in API version 55.0 and later."
    },
    "InvoiceBatchRunId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Id of the invoice batch run that generated this invoice. This field is a relationship field. This field is available in API version 55.0 and later.",
      "relationship_name": "InvoiceBatchRun",
      "relationship_type": "Lookup",
      "refers_to": "InvoiceBatchRun"
    },
    "InvoiceDate": {
      "type": "date",
      "properties": "Filter, Group, Sort, Update",
      "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 has a DueDate of 05/01."
    },
    "InvoiceNumber": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort, Update",
      "description": "System-created unique ID for this invoice."
    },
    "LastReferencedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp when the current user last accessed this record, a record related to this record, or a list view. This field is available in API version 55.0 and later."
    },
    "LastViewedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp when the current user last accessed 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. This field is available in API version 55.0 and later."
    },
    "NetCreditsApplied": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "Represents the net credits applied to an invoice. Calculated by subtracting the sum of all unapplied lines from the sum of all applied lines. This field is a calculated field. This field is available in API version 55.0 and later."
    },
    "NetPaymentsApplied": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "Represents net payments applied to an invoice. Calculated by subtracting the sum of unapplied payments from the sum of payments applied to the invoice. This field is a calculated field. This field is available in API version 55.0 and later."
    },
    "OwnerId": {
      "type": "reference",
      "properties": "Filter, Group, Sort, Update",
      "description": "The user who owns an invoice record. This field is a polymorphic relationship field.",
      "relationship_name": "Owner",
      "relationship_type": "Lookup",
      "refers_to": "Group, User"
    },
    "PaymentExclusionReason": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The reason for skipping creation of payment schedules and payment schedule items for the invoice. This field is only available if Commerce Subscriptions is enabled for your org. Available in API version 63.0 and later."
    },
    "PaymentTermId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort, Update",
      "description": "ID of the payment term used on this invoice. This field is a relationship field. This field is available in API version 55.0 and later.",
      "relationship_name": "PaymentTerm",
      "relationship_type": "Lookup",
      "refers_to": "PaymentTerm"
    },
    "PostedDate": {
      "type": "date",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The date the invoice was posted. This field is available in API version 60.0 and later."
    },
    "ReferenceEntityId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort, Update",
      "description": "The ID of the order or order summary that created this invoice. This field is a polymorphic relationship field.",
      "relationship_name": "ReferenceEntity",
      "relationship_type": "Lookup",
      "refers_to": "Order, OrderSummary"
    },
    "SettlementStatus": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The state of the invoice's payment. Possible values are: Not Applicable Not Settled Partially Settled Settled This field is available when Subscription Management is enabled. This field is available in API version 55.0 and later."
    },
    "ShouldExcludePayment": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "Indicates whether to skip creating payment schedules and payment schedule items for the invoice (true) or not (false). The default value is false. This field is only available if Commerce Subscriptions is enabled for your org. Available in API Version 63.0 and later.",
      "required": true
    },
    "Status": {
      "type": "picklist",
      "properties": "Filter, Group, Restricted picklist, Sort",
      "description": "The state of the invoice. Possible values are: Canceled— Indicates that the invoice was generated and later canceled. Draft— Indicates that the invoice is a draft. Available in API version 60.0 and later. Draft In Progress— Indicates that the draft invoice is in progress. Available in API version 60.0 and later. 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. Available in API version 60.0 and later. Void In Progress— Indicates that the invoice is pending a status change. Voided— The invoice’s status after the API successfully voids the invoice."
    },
    "TaxLocaleType": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "The system used to handle tax on the original Order associated with the Invoice. Gross usually applies to taxes like value-added tax (VAT), and Net usually applies to taxes like sales tax. This field is available when Order Management or B2B Commerce is enabled. Possible values are: Gross: Displays most prices and taxes as combined values Net: Displays most prices and taxes as separate values This field is available in API version 56.0 and later."
    },
    "TotalAdjustmentAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The sum of the invoice’s adjustment line amounts."
    },
    "TotalAdjustmentAmountWithTax": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The sum of the amount fields on the invoice's adjustment-type invoice lines, including tax. This field is available in API version 55.0 and later."
    },
    "TotalAdjustmentTaxAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The total amount of tax applied to the invoice line's adjustment lines. This field is available in API version 55.0 and later."
    },
    "TotalAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The sum TotalAmount values on the invoice’s lines. This field is a calculated field."
    },
    "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. 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. This field is available in API version 55.0 and later."
    },
    "TotalChargeTaxAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The total amount of tax applied to the invoice's charge lines. This field is available in API version 55.0 and later."
    },
    "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. This field is available when Subscription Management is enabled. This field is available in API version 56.0 and later."
    },
    "TotalTaxAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The sum of TaxAmount values on the invoice lines. This field is a calculated field."
    }
  },
  "special_access_rules": "This object is available with Salesforce Order Management or D2C Commerce license, and Billing (Revenue Cloud). A few fields require Commerce Subscriptions to be enabled. These fields are available only in Lightning Experience. For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the Revenue Cloud Developer Guide.\n\nThis object is available with Salesforce Order Management or D2C Commerce license, and Billing (Revenue Cloud). A few fields require Commerce Subscriptions to be enabled. These fields are available only in Lightning Experience.\n\nFor information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the Revenue Cloud Developer Guide.",
  "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.\n\n- **InvoiceFeed**: Feed tracking is available for the object.\n- **InvoiceHistory**: History is available for tracked fields of the object.\n- **InvoiceOwnerSharingRule**: Sharing rules are available for the object.\n- **InvoiceShare**: Sharing is available for the object.",
  "field_reference": {
    "AppType": {
      "field_label": "App Type",
      "type": "picklist",
      "length": "255"
    },
    "Balance": {
      "field_label": "Balance",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "BalanceValue": {
      "field_label": "Balance Value",
      "type": "double",
      "precision": "18",
      "scale": "6"
    },
    "BillToContactId": {
      "field_label": "Contact ID",
      "type": "reference",
      "length": "18"
    },
    "BillingAccountId": {
      "field_label": "Account ID",
      "type": "reference",
      "length": "18"
    },
    "BillingArrangementId": {
      "field_label": "Billing Arrangement ID",
      "type": "reference",
      "length": "18"
    },
    "BillingArrangementVerNumber": {
      "field_label": "Billing Arrangement Version Number",
      "type": "int",
      "digits": "9"
    },
    "BillingProfileId": {
      "field_label": "Billing Account ID",
      "type": "reference",
      "length": "18"
    },
    "ChildInvoiceCount": {
      "field_label": "Child Invoice Count",
      "type": "int",
      "digits": "9"
    },
    "CorpCrcyCnvTotAmtWithTax": {
      "field_label": "Corporate Currency Converted Total Amount With Tax",
      "type": "double",
      "precision": "18",
      "scale": "6"
    },
    "CorporateCurrencyCvsnDate": {
      "field_label": "Corporate Currency Conversion Date",
      "type": "date"
    },
    "CorporateCurrencyCvsnRate": {
      "field_label": "Corporate Currency Conversion Rate",
      "type": "double",
      "precision": "18",
      "scale": "10"
    },
    "CorporateCurrencyIsoCode": {
      "field_label": "Corporate Currency ISO Code",
      "type": "string",
      "length": "40"
    },
    "CorrelationIdentifier": {
      "field_label": "Correlation Identifier",
      "type": "string",
      "length": "255"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "CreationMode": {
      "field_label": "Creation Mode",
      "type": "picklist",
      "length": "255"
    },
    "CreditInvoiceTaxDocNumber": {
      "field_label": "Credit Invoice Tax DocNumber",
      "type": "string",
      "length": "255"
    },
    "CurrencyIsoCode": {
      "field_label": "Currency ISO Code",
      "type": "picklist",
      "length": "3"
    },
    "DaysInvoiceOpen": {
      "field_label": "Days Invoice Open",
      "type": "int",
      "digits": "9"
    },
    "DaysInvoiceOverdue": {
      "field_label": "Days Invoice Overdue",
      "type": "int",
      "digits": "9"
    },
    "DebitInvoiceTaxDocNumber": {
      "field_label": "Debit Invoice Tax Doc Number",
      "type": "string",
      "length": "255"
    },
    "Description": {
      "field_label": "Description",
      "type": "string",
      "length": "255"
    },
    "DocumentNumber": {
      "field_label": "Document Number",
      "type": "string",
      "length": "255"
    },
    "DueDate": {
      "field_label": "Due Date",
      "type": "date"
    },
    "FullSettlementDate": {
      "field_label": "Full Settlement Date",
      "type": "date"
    },
    "FuncCrcyCnvTotAmtWithTax": {
      "field_label": "Functional Currency Converted Total Amount With Tax",
      "type": "double",
      "precision": "18",
      "scale": "6"
    },
    "FunctionalCurrencyCvsnDate": {
      "field_label": "Functional Currency Conversion Date",
      "type": "date"
    },
    "FunctionalCurrencyCvsnRate": {
      "field_label": "Functional Currency Conversion Rate",
      "type": "double",
      "precision": "18",
      "scale": "10"
    },
    "FunctionalCurrencyIsoCode": {
      "field_label": "Functional Currency ISO Code",
      "type": "string",
      "length": "40"
    },
    "GroupingKey": {
      "field_label": "Grouping Key",
      "type": "string",
      "length": "255"
    },
    "Id": {
      "field_label": "Invoice ID",
      "type": "id",
      "length": "18"
    },
    "InvBatchDraftToPostedRunId": {
      "field_label": "Invoice Batch Draft to Posted Run ID",
      "type": "reference",
      "length": "18"
    },
    "InvoiceBatchRunId": {
      "field_label": "Invoice Batch Run ID",
      "type": "reference",
      "length": "18"
    },
    "InvoiceDate": {
      "field_label": "Invoice Date",
      "type": "date"
    },
    "InvoiceLockedDateTime": {
      "field_label": "Invoice Locked Date Time",
      "type": "datetime"
    },
    "InvoiceNumber": {
      "field_label": "Invoice Number",
      "type": "string",
      "length": "255"
    },
    "InvoiceReference": {
      "field_label": "Invoice Reference",
      "type": "string",
      "length": "255"
    },
    "IsBillingScheduleGroupSkipped": {
      "field_label": "Is Billing Schedule Skipped",
      "type": "boolean"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "IsInvoiceLocked": {
      "field_label": "Invoice Locked",
      "type": "boolean"
    },
    "LastEmailDispatchStatus": {
      "field_label": "Last Email Dispatch Status",
      "type": "picklist",
      "length": "255"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "LegalEntityAccountingPeriodId": {
      "field_label": "Legal Entity Accounting Period ID",
      "type": "reference",
      "length": "18"
    },
    "LegalEntityId": {
      "field_label": "Legal Entity ID",
      "type": "reference",
      "length": "18"
    },
    "NetCreditsApplied": {
      "field_label": "Net Credits Applied",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "NetPaymentsApplied": {
      "field_label": "Net Payments Applied",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "OwnerId": {
      "field_label": "Owner ID",
      "type": "reference",
      "length": "18"
    },
    "PaymentExclusionReason": {
      "field_label": "Skip Payment Schedule Creation Reason",
      "type": "string",
      "length": "40"
    },
    "PaymentScheduleId": {
      "field_label": "Payment Schedule ID",
      "type": "reference",
      "length": "18"
    },
    "PaymentTermId": {
      "field_label": "Payment Term ID",
      "type": "reference",
      "length": "18"
    },
    "PostedDate": {
      "field_label": "Posted Date",
      "type": "date"
    },
    "ReferenceEntityId": {
      "field_label": "ReferenceEntity ID",
      "type": "reference",
      "length": "18"
    },
    "SavedPaymentMethodId": {
      "field_label": "Saved Payment Method ID",
      "type": "reference",
      "length": "18"
    },
    "SettlementLevel": {
      "field_label": "Settlement Level",
      "type": "picklist",
      "length": "255"
    },
    "SettlementStatus": {
      "field_label": "Settlement Status",
      "type": "picklist",
      "length": "255"
    },
    "ShouldExcludePayment": {
      "field_label": "Skip Payment Schedule Creation",
      "type": "boolean"
    },
    "Status": {
      "field_label": "Status",
      "type": "picklist",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "TaxLocaleType": {
      "field_label": "Tax Locale Type",
      "type": "picklist",
      "length": "255"
    },
    "TotalAdjustmentAmount": {
      "field_label": "Total Adjustment Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalAdjustmentAmountWithTax": {
      "field_label": "Total Adjustment Amount with Tax",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalAdjustmentTaxAmount": {
      "field_label": "Total Adjustment Tax Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalAmount": {
      "field_label": "Total Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalAmountWithTax": {
      "field_label": "Total with Tax",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalChargeAmount": {
      "field_label": "Total Charges",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalChargeAmountWithTax": {
      "field_label": "Total Charge Amount with Tax",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalChargeTaxAmount": {
      "field_label": "Total Charge Tax Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalConvertedNegAmount": {
      "field_label": "Total Converted Negative Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalTaxAmount": {
      "field_label": "Total Tax",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalTaxesCapturedAtHeader": {
      "field_label": "Total Taxes Captured at Header",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "UniqueIdentifier": {
      "field_label": "Unique Identifier",
      "type": "string",
      "length": "255"
    },
    "WriteOffStatus": {
      "field_label": "Write Off Status",
      "type": "picklist",
      "length": "255"
    },
    "WriteOffTotalChargeAmount": {
      "field_label": "Write Off Total Charge Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "WriteOffTotalTaxAmount": {
      "field_label": "Write Off Total Tax Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "precision",
    "scale",
    "digits"
  ]
}