blng__PaymentScheduler__c

Represents automating payment runs by creating payment schedulers, which process the payment runs on a recurring basis.

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 scheduler 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.

LastReferencedDate 

Type: dateTime

Properties: Filter, Nillable, Sort

Description: The timestamp when the current user last accessed a payment scheduler 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 a payment scheduler record. If this value is null, it’s possible that the user only accessed the payment scheduler record or a related list view (LastReferencedDate), but not viewed the payment scheduler record itself.

Name 

Type: string

Properties: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update

Description: The name of the payment scheduler.

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__ApexJobId__c 

Type: string

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: A unique identifier of an Apex job associated with the payment scheduler.

blng__IncludeAllCurrencies__c 

Type: boolean

Properties: Create, Defaulted on create, Filter, Group, Sort, Update

Description: Required. Indicates whether to include all currencies in the payment run (true) or not (false).

The default value is false.

blng__Notes__c 

Type: textarea

Properties: Create, Nillable, Update

Description: Additional details or comments related to the payment scheduler.

blng__PaymentBatches__c 

Type: multipicklist

Properties: Create, Filter, Nillable, Restricted picklist, Update

Description: A collection of several payments combined for processing.

blng__PaymentGateway__c 

Type: reference

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The Salesforce Billing payment gateway record used to establish communication with the external payment gateway.

This field is a relationship field.

Relationship Name: blng__PaymentGateway__r

Relationship Type: Lookup

Refers To: blng__PaymentGateway__c

blng__PaymentType__c 

Type: multipicklist

Properties: Create, Filter, Nillable, Restricted picklist, Update

Description: The type of payment in the payment schedule.

Valid values are:

  • ACH
  • Credit Card

blng__Startdateandtime__c 

Type: dateTime

Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update

Description: The start date and time of the payment scheduler.

blng__TargetDate__c 

Type: date

Properties: Create, Defaulted on create, Filter, Group, Sort, Update

Description: Required. The target date for the payment run. Billing schedules having the next billing date before this date is picked up for invoicing.

blng__TargetDayOfMonth__c 

Type: picklist

Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description: In a monthly schedule, the designated day of the month for the payment run.

blng__TargetDayofWeek__c 

Type: picklist

Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description: In a weekly schedule, the designated day of the week for the payment run.

blng__Type__c 

Type: picklist

Properties: Create, Filter, Group, Restricted picklist, Sort, Update

Description: Required. The type of payment schedule.

Valid values are:

  • Daily
  • Monthly
  • Once
  • Weekly