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

BillingBatchFilterCriteria

Represents the filter that all eligible billing schedules must satisfy in order to be picked up by an invoice run. This object is available in API version 62.0 and later.

Supported Calls

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

Special Access Rules

You need the Billing Admin permission set to access this object.

Fields

Field Details
BatchCriteriaId
Type
reference
Properties
Filter, Group, Sort
Description
Required. The ID of the batch criteria record.
This field is a polymorphic relationship field.
Relationship Name
BatchCriteria
Refers To
InvoiceBatchRunCriteria
BillingBatchFilterCriteriaNumber
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Required. The auto-generated reference number for the billing batch filter criteria.
ColumnEnum
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Required. The column or field to which the filter criteria are applied.
CriteriaFieldType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The data type of the custom or standard criteria field.
Valid values are:
  • CustomBoolean
  • CustomCurrency
  • CustomDate
  • CustomLookup
  • CustomNumber
  • CustomPercent
  • CustomText
Available in API version 63.0 and later.
CriteriaSequence
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The order in which the filter criteria are applied on the billing batch.
InvoiceRunMatchingValue
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
A value to match during an invoice run. This field is useful for filtering the invoices based on specific criteria during the billing process.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this 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 this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly.
ObjectName
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Required. The object on which the filter criteria are applied.
Valid values are:
  • AccountBillingAccount — Available in API version 63.0 and later.
  • BillingAccount — Available in API version 63.0 and later.
  • BillingSchedule
  • BillingScheduleGroup
  • CreditMemo — Available in API version 63.0 and later.
  • CreditMemoInvApplication — Available in API version 63.0 and later.
  • CreditMemoLine — Available in API version 63.0 and later.
  • CreditMemoLineInvoiceLine — Available in API version 63.0 and later.
  • CreditMemoLineTax — Available in API version 63.0 and later.
  • Invoice — Available in API version 63.0 and later.
  • InvoiceLine — Available in API version 63.0 and later.
  • InvoiceLineTax — Available in API version 63.0 and later.
Operation
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Required. The type of comparison or logical operation to be performed on the specified column or field.
Valid values are:
  • Contains — Available in API version 63.0 and later.
  • Equals
  • GreaterThan — Available in API version 63.0 and later.
  • GreaterThanOrEqualTo — Available in API version 63.0 and later.
  • InList
  • LessThan — Available in API version 63.0 and later.
  • LessThanOrEqualTo
  • NotEquals — Available in API version 63.0 and later.
  • OfType
  • StartsWith — Available in API version 63.0 and later.
OwnerId
Type
reference
Properties
Filter, Group, Sort
Description
Required. The ID of the user who created the billing batch filter criteria.
This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
Group, User
PaymentRunMatchingValue
Type
picklist
Properties
Filter, Group, Nillable, Sort
Description
A value to match during a payment run. This field is useful for filtering the payments based on specific criteria during the billing process. This field is visible but isn't used in API version 62.0.
StandardCriteriaField
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The name of the standard field for the object specified in the ObjectName field. The filter criteria is applied on the standard field. Available in API version 63.0 and later.
Value
Type
string
Properties
Filter, Group, Sort
Description
Required. The value to be used in the filter criteria.

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.

BillingBatchFilterCriteriaHistory
History is available for tracked fields of the object.