Newer Version Available

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

blng__Payment__c

Represents a single event when a shopper makes a payment. For credit cards, this event is a payment capture or payment sale, but it doesn't appear on the shopper's credit card statement.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
CurrencyIsoCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Three-letter ISO 4217 currency code associated with the payment record.
LastActivityDate
Type
date
Properties
Filter, Group, Nillable, Sort
Description
The timestamp of when a user had last associated a task or event action with this record.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed a payment 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 record. If this value is null, it’s possible that the user only accessed the payment record or a related list view (LastReferencedDate), but not viewed the payment record itself.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Required. The name of the payment record.
blng__Account__c
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
Required. The account of the customer who made the payment.
This field is a relationship field.
Relationship Name
blng__Account__r
Relationship Type
Master-detail
Refers To
Account (the master object)
blng__AllocatedtoDebitNoteLines__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The assigned payments to the debit note lines within your account.
This field is a calculated field.
blng__AllocatedtoInvoiceLines__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The assigned payments to the invoice lines within an account.
This field is a calculated field.
blng__AllocatedtoInvoices__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The assigned payments to the invoice within an account.
This field is a calculated field.
blng__AllocationStatus__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Indicates whether a payment has been allocated to invoices, invoice lines, and debit note lines. A status of Fail means the payment has not yet been allocated.
blng__Allocations__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The total sum of payments allocated to invoices, invoice lines, and debit note lines.
This field is a calculated field.
blng__Amount__c
Type
currency
Properties
Create, Filter, Sort, Update
Description
Required. The amount to be debited or captured.
blng__Balance__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The amount remaining after deducting the net applied amount from total amount.
This field is a calculated field.
blng__BankAccountName__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The bank account name of the customer who made the payment.
blng__BankAccountNumber__c
Type
encryptedstring
Properties
Create, Nillable, Update
Description
The bank account number of the customer who made the payment.
blng__BankAccountType__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The bank account type of the customer who made the payment. Valid values are:
  • Business Checking
  • Checking
  • Savings
blng__BankName__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The bank name of the customer who made the payment.
blng__BankRoutingCode__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The valid routing number of the bank of the customer, also called as the American Bankers Association (ABA) code.
blng__BaseCurrencyAmount__c
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The amount of the payment in the base currency of the organization. It’s used to standardize the amount across different currencies.
blng__BaseCurrencyFXDate__c
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date on which the Foreign Exchange (FX) rate is applied to convert an amount into the base currency.
blng__BaseCurrencyFXRate__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The FX rate used to convert an amount from a foreign currency to the base currency.
blng__BaseCurrency__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The primary currency in which the financial transactions are recorded and reported.
blng__BillingFinanceBook__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The financial ledger that tracks all transactions related to billing, including the allocation of payments to debit note lines. It ensures that all financial activities are accurately recorded and reported.
This field is a relationship field.
Relationship Name
blng__BillingFinanceBook__r
Relationship Type
Lookup
Refers To
blng__FinanceBook__c
blng__BillingFinancePeriod__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A specific time frame for financial reporting and accounting purposes.
This field is a relationship field.
Relationship Name
blng__BillingFinancePeriod__r
Relationship Type
Lookup
Refers To
blng__FinancePeriod__c
blng__CardCodeResponse__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The response code from the card issuer. This code indicates the result of the authorization request for a credit card transaction.
blng__CardExpirationMonth__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The expiration month of a credit or debit card in the billing information. This information is sent from the payment gateway following a transaction request.
blng__CardExpirationYear__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The expiration year of a credit or debit card in the billing information. This information is sent from the payment gateway following a transaction request.
blng__CardType__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The credit or debit card type in the billing information.
Valid values are:
  • American Express
  • Discover
  • Mastercard
  • Visa
blng__CheckDate__c
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date on which a check payment was issued or received.
blng__CheckNumber__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The check number issued in an external system for a refund.
blng__FinancePeriod__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A finance period stores lookups to all the accounting or revenue transactions associated with the payment that occurred within a period of time. This field is a relationship field.
Relationship Name
blng__FinancePeriod__r
Relationship Type
Lookup
Refers To
blng__FinancePeriod__c
blng__GLRule__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The accounting treatment for financial transactions, including which general ledger accounts to debit and credit.
This field is a relationship field.
Relationship Name
blng__GLRule__r
Relationship Type
Lookup
Refers To
blng__GLRule__c
blng__GLTreatment__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The general ledger treatment defines how a financial transaction is recorded in the general ledger, specifying the accounts and the nature of the entries.
This field is a relationship field.
Relationship Name
blng__GLTreatment__r
Relationship Type
Lookup
Refers To
blng__GLTreatment__c
blng__GatewayID__c
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
A unique transaction ID created by the payment gateway.
blng__ImpactAmount__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The payment's financial impact against the customer's accounts receivable.
This field is a calculated field.
blng__Invoice__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The invoice to which the payment has been applied or unapplied.
This field is a relationship field.
Relationship Name
blng__Invoice__r
Relationship Type
Lookup
Refers To
blng__Invoice__c
blng__LegalEntity__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The legal entity used to associate the payment with other transactional records in Salesforce Billing.
This field is a relationship field.
Relationship Name
blng__LegalEntity__r
Relationship Type
Lookup
Refers To
blng__LegalEntity__c
blng__Notes__c
Type
textarea
Properties
Create, Nillable, Update
Description
Additional information or comments related to the payment.
blng__PaidBy__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The customer who made a payment, the payment amount, and other details.
This field is a relationship field.
Relationship Name
blng__PaidBy__r
Relationship Type
Lookup
Refers To
Contact
blng__PaymentAuthorization__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The authorization record for this payment. If there's a delayed capture (when the capture occurs after the authorization), all captures must be made against a previously successful authorization transaction.
This field is a relationship field.
Relationship Name
blng__PaymentAuthorization__r
Relationship Type
Lookup
Refers To
blng__PaymentAuthorization__c
blng__PaymentDate__c
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date on which the payment was made.
blng__PaymentDescription__c
Type
textarea
Properties
Create, Nillable, Update
Description
The additional details about the payment.
blng__PaymentGatewayToken__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A unique string of numbers that’s used to process transactions without exposing the actual payment information.
blng__PaymentGateway__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the payment gateway that processed the payment. If there’s a delayed payment, the field is populated from the authorization record.
This field is a relationship field.
Relationship Name
blng__PaymentGateway__r
Relationship Type
Lookup
Refers To
blng__PaymentGateway__c
blng__PaymentMethod__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The payment method associated with the payment.
This field is a relationship field.
Relationship Name
blng__PaymentMethod__r
Relationship Type
Lookup
Refers To
blng__PaymentMethod__c
blng__PaymentMode__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The mode of payment. Select Electronic if the payments are processed through Salesforce Billing and External to manually enter a payment that was processed outside of Salesforce.
Valid values are:
  • Electronic
  • External
blng__PaymentType__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The payment type for a payment.
Valid values are:
  • ACH
  • Bank Transfer
  • Cash
  • Check
  • Credit Card
blng__RefundsAllocations__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The total refund that has been allocated against this payment. This field is a calculated field.
blng__RefundsUnallocations__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The total number of a previously applied refund that has since been unapplied from this payment. This field is a calculated field.
blng__Refunds__c
Type
currency
Properties
Filter, Nillable, Sort
Description
A refund that's applied to a payment.
This field is a calculated field.
blng__RequestCreditCardNumber__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A tokenized version of the credit card number sent to the customer bank within the transaction request. Salesforce Billing doesn’t store credit card numbers or other sensitive customer payment information. Instead, it stores tokenized versions of that information and sends the tokens to the external payment gateway.
blng__RequestTypeOfPayment__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The type of payment action requested of the customer bank: authorization, charge, void, or refund.
blng__Status__c
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The status of the payment transaction. Valid values are:
  • Cancelled—The payment has been voided and can no longer be allocated.
  • Draft—The payment can be edited before posting and allocating it to a target.
  • Processed—The payment has been finalized and can be allocated against a target.
  • Failed—The authorization for the payment failed.
The default value is Draft.
blng__Transaction__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The financial activities or operations that are recorded as part of a payment.
This field is a relationship field.
Relationship Name
blng__Transaction__r
Relationship Type
Lookup
Refers To
blng__PaymentTransaction__c
blng__UnallocatedfromDebitNoteLines__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The amount from debit note lines that has not been allocated to any specific payment.
This field is a calculated field.
blng__UnallocatedfromInvoiceLines__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The amount from invoice lines that has not been allocated to any specific payment.
This field is a calculated field.
blng__UnallocatedfromInvoices__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The amount from invoice that has not been allocated to any specific payment.
This field is a calculated field.
blng__Unallocations__c
Type
currency
Properties
Filter, Nillable, Sort
Description
The total unallocated amounts in a payment.
This field is a calculated field.