Salesforce Billing Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Salesforce Billing Fields on Standard Objects
Salesforce Billing Custom Objects
blng__AccountBalanceSnapshot__c
blng__AgingBuckets__c
blng__BalanceSnapShotRun__c
blng__BalanceSnapShotScheduler__c
blng__BillingBatchJob__c
blng__BillingPrefix__c
blng__BillingRule__c
blng__BillingSchedule__c
blng__BillingTransaction__c
blng__BillingTreatment__c
blng__CreditNote__c
blng__CreditNoteAllocation__c
blng__CreditNoteLine__c
blng__DebitNote__c
blng__DebitNoteLine__c
blng__FinanceBook__c
blng__FinancePeriod__c
blng__GLAccount__c
blng__GLRule__c
blng__GLTreatment__c
blng__Invoice__c
blng__InvoiceLine__c
blng__InvoicePlan__c
blng__InvoicePlanLine__c
blng__InvoiceRun__c
blng__InvoiceScheduler__c
blng__LegalEntity__c
blng__Payment__c
blng__PaymentAllocationDebitNoteLine__c
blng__PaymentAllocationInvoice__c
blng__PaymentAllocationInvoiceLine__c
blng__PaymentAuthorization__c
blng__PaymentGateway__c
blng__PaymentGatewayConfig__c
blng__PaymentMapping__c
blng__PaymentMethod__c
blng__PaymentRun__c
blng__PaymentScheduler__c
blng__PaymentTerms__c
blng__PaymentTransaction__c
blng__Refund__c
blng__RefundLineCreditNoteLine__c
blng__RefundLinePayment__c
blng__RevenueAdjustment__c
blng__RevenueAdjustmentLine__c
blng__RevenueAgreement__c
blng__RevenueDistributionMethod__c
blng__RevenueRecognitionRule__c
blng__RevenueRecognitionTreatment__c
blng__RevenueSchedule__c
blng__RevenueTransaction__c
blng__SubInvoiceLine__c
blng__TaxConfig__c
blng__TaxIntegration__c
blng__TaxRate__c
blng__TaxRule__c
blng__TaxTreatment__c
blng__Usage__c
blng__UsageSummary__c
Salesforce Billing Developer Guides & Lightning Components
PDF

blng__PaymentTransaction__c

Represents the payment transactions associated with a payment.

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
The three-letter ISO 4217 currency code associated with the payment transaction record when multiple currencies are enabled.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed a payment transaction 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 transaction record. If this value is null, it’s possible that the user only accessed the payment transaction record or a related list view (LastReferencedDate), but not viewed the payment transaction record itself.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Required. The name of the payment transaction.
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__AVSResponseCode__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The numeric value contained in a gateway response alongside the response status, response, and response message. The code is used as an indexing value for different types of responses. You can generally ignore it and focus on the response and response message to get the details you need about the results of your transaction request.
blng__AVSZip__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The numeric address and zip code used as an indexing value.
blng__Account__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The account containing the invoice that the payment transaction is set to pay.
This field is a relationship field.
Relationship Name
blng__Account__r
Relationship Type
Lookup
Refers To
Account
blng__Amount__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The amount that Salesforce Billing attempts to use against the balance of an invoice.
blng__Authorization__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The approval from a customer's bank or credit card issuer to charge a payment to their account.
blng__BankAccountName__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A user-defined value for the bank account name. This field used to record information about externally recorded Automated Clearing House (ACH) payments.
blng__BankAccountNumber__c
Type
encryptedstring
Properties
Create, Nillable, Update
Description
A user-defined value for the bank account number. This field used to record information about externally recorded ACH payments.
blng__BankAccountType__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
A user-defined value for the bank account type. This field used to record information about externally recorded ACH payments. Valid values are:
  • Business Checking
  • Checking
  • Savings
blng__BankName__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A user-defined value for the bank name. This field used to record information about externally recorded ACH payments.
blng__BankRoutingCode__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A user-defined value for the bank routing code. This field used to record information about externally recorded ACH payments.
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__ExceptionMessage__c
Type
textarea
Properties
Create, Nillable, Update
Description
The message displayed when a transaction is created without any associated payment against the invoice.
blng__GatewayDate__c
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date that the transaction request occurred in the payment gateway.
blng__GatewayID__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A unique identification number associated with the transaction request that occurred in the payment gateway.
blng__GatewayRequest__c
Type
textarea
Properties
Create, Nillable, Update
Description
The payment request to a payment gateway.
blng__GatewayResponse__c
Type
textarea
Properties
Create, Nillable, Update
Description
The response from the payment gateway.
blng__GatewayStatus__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The values that summarizes the payment gateway’s response to the payment transaction request. Valid values are:
  • Decline
  • Indeterminate
  • PermanentFail
  • RequiresReview
  • Success
  • SystemError
  • ValidationError
blng__IsPaymentProcessedSuccessfully__c
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Required. Indicates whether Salesforce Billing created a payment for a successful transaction (true) or not (false). If this field is deselected on a successful transaction, review why Salesforce Billing didn’t create the payment, For example, the user who owns the payment run didn’t have the permission to access payment records. After you resolve the issue, create a payment for the same amount as the payment transaction, and then allocate it to the transaction’s invoice on your own.
The default value is false.
blng__Notes__c
Type
textarea
Properties
Create, Nillable, Update
Description
Additional information or comments related to the payment transaction.
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 inherited from the payment method.
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 used to provide customer payment information to the payment gateway.
This field is a relationship field.
Relationship Name
blng__PaymentMethod__r
Relationship Type
Lookup
Refers To
blng__PaymentMethod__c
blng__PaymentRun__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The payment run that created the payment transaction to record the result of external payment gateway communication.
This field is a relationship field.
Relationship Name
blng__PaymentRun__r
Relationship Type
Lookup
Refers To
blng__PaymentRun__c
blng__ReasonCode__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The reason for a particular payment transaction.
blng__RequestCreditCardNumber__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The credit card number associated with a payment transaction.
blng__RequestInvoice__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The invoice that Salesforce Billing is attempting to pay through the payment transaction. If the transaction is successful, Salesforce Billing creates a payment record and attempts to allocate it to the invoice.
This field is a relationship field.
Relationship Name
blng__RequestInvoice__r
Relationship Type
Lookup
Refers To
blng__Invoice__c
blng__RequestTransactionType__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__RequestTypeOfPayment__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The type of payment being requested.
blng__ResponseCode__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The numeric value contained in a gateway response alongside the response status, response, and response message. The code is used as an indexing value for different types of responses. You can generally ignore it and focus on the response and response message to get the details you need about the results of your transaction request.
blng__ResponseMessage__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The message sent from the external payment gateway to show the result of the transaction request. You can review this message for additional context regarding the value of the transaction’s gateway status.
blng__ResponseStatus__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The message sent from the external payment gateway to show the result of the transaction request. While this value can vary between gateways, it’s often the same as the response message.
blng__Response__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A detailed message contained in a gateway response alongside the response code, response, response status, and response message. Although specific responses vary between gateways, the response usually provides more information about the response message.
blng__SourceTransactionId__c
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
A unique identifier of the source transaction that’s associated with the payment.
blng__Status__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The status of the payment transaction. The transaction’s status is 
In Progress
while the external payment gateway communicates with the customer bank. Salesforce Billing changes it to Completed after the gateway returns a transaction response. Valid values are:
  • Completed
  • In Progress
  • Processed
blng__Transaction__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
All customer transactions in a payment transaction.
This field is a relationship field.
Relationship Name
blng__Transaction__r
Relationship Type
Lookup
Refers To
blng__PaymentTransaction__c
blng__Type__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The type of action requested from the customer bank. Valid values are:
  • Authorization
  • Capture
  • Charge
  • Refund
  • Void