blng__PaymentRun__c
Represents a batch processing job in Salesforce Billing. During a payment run, all payment schedules that meet the specified criteria are processed, resulting in the collection of payments.
Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields
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 payment authorization when multiple currencies are enabled.
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 account.
Name
Type: string
Properties: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update
Description: The name of the payment run.
OwnerId
Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Required. The ID of the record owner.
This field is a polymorphic relationship field.
Relationship Name: Owner
Relationship Type: Lookup
Refers To: Group, User
blng__ApexJobIdForCleanUp__c
Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: A unique identifier of an Apex job that’s responsible for the cleanup tasks.
blng__ApexJobId__c
Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: A unique identifier of an Apex job associated with the payment run.
blng__CleanUpStatus__c
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The status of the cleanup operations associated with the payment run.
Valid values are:
Completed
Started
Step 1 : Invoice update
Step 2 : Payment Transaction update
blng__CompletedTime__c
Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The time when the payment run was completed.
blng__FailedTransactions__c
Type: double
Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
Description: The details of transactions that failed during the payment run process.
blng__InvoicesProcessed__c
Type: double
Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
Description: The invoices that were successfully processed during the payment run.
blng__PaymentGateway__c
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The payment gateway used to process the transactions during the payment run.
This field is a relationship field.
Relationship Name: blng__PaymentGateway__r
Relationship Type: Lookup
Refers To: blng__PaymentGateway__c
blng__PaymentScheduler__c
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The payment scheduler responsible for the payment run.
This field is a relationship field.
Relationship Name: blng__PaymentScheduler__r
Relationship Type: Lookup
Refers To: blng__PaymentScheduler__c
blng__StartTime__c
Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The start time of the payment run.
blng__Status__c
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The status of the payment run.
Valid values are:
Completed
Failed
Processing
Started
blng__SuccessfulTransactions__c
Type: double
Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
Description: The number of transactions that were successfully processed during the payment run.
blng__TargetDate__c
Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date by which the payment run is intended to be completed.
blng__TotalPaymentProcessed__c
Type: currency
Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
Description: The total number of payments that were successfully processed during the payment run.
blng__TransactionsGenerated__c
Type: double
Properties: Filter, Nillable, Sort
Description: The number of transactions that were generated during the payment run.
This field is a calculated field.