Payment
Represents a payment made by a customer, typically toward an invoice or order.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
Unique identifier for the record. | |
| IsDeleted | Bool | True |
Indicates whether the record has been moved to the Recycle Bin. | |
| PaymentNumber | String | True |
Payment identification number. | |
| CurrencyIsoCode | String | False |
ISO code for the currency in which the revenue amount is expressed. | |
| CreatedDate | Datetime | True |
Date and time when the record was created. | |
| CreatedById | String | True |
User.Id |
ID of the user who created the record. |
| LastModifiedById | String | True |
User.Id |
ID of the user who last modified the record. |
| LastViewedDate | Datetime | True |
Date and time when the record was last viewed in the user interface. | |
| LastReferencedDate | Datetime | True |
Date and time when the record was last referenced. | |
| PaymentGroupId | String | False |
PaymentGroup.Id |
ID of the PaymentGroup associated with this record. |
| AccountId | String | False |
Account.Id |
ID of the Account associated with this record. |
| PaymentAuthorizationId | String | False |
ID of the PaymentAuthorization associated with this record. | |
| Date | Datetime | False |
Date associated with . | |
| CancellationDate | Datetime | False |
Indicates whether the user or record can perform cellationDate action. | |
| Amount | Decimal | False |
Estimated total sale amount. | |
| Status | String | False |
Status of the record. | |
| Type | String | False |
Type of account or classification. | |
| ProcessingMode | String | False |
Mode used for processing the payment. | |
| GatewayRefNumber | String | False |
GatewayRef identification number. | |
| ClientContext | String | True |
Field containing ClientContext information. | |
| GatewayResultCode | String | False |
Result code returned by the payment gateway. | |
| SfResultCode | String | False |
Salesforce-specific result code for the transaction. | |
| GatewayDate | Datetime | False |
Date associated with Gateway. | |
| CancellationGatewayRefNumber | String | False |
Indicates whether the user or record can perform cellationGatewayRefNumber action. | |
| CancellationGatewayResultCode | String | False |
Indicates whether the user or record can perform cellationGatewayResultCode action. | |
| CancellationSfResultCode | String | False |
Indicates whether the user or record can perform cellationSfResultCode action. | |
| CancellationGatewayDate | Datetime | False |
Indicates whether the user or record can perform cellationGatewayDate action. | |
| Comments | String | False |
Field containing Comments information. | |
| ImpactAmount | Decimal | True |
Amount by which this payment impacts the associated record's balance. | |
| EffectiveDate | Datetime | False |
Date associated with Effective. | |
| CancellationEffectiveDate | Datetime | False |
Indicates whether the user or record can perform cellationEffectiveDate action. | |
| GatewayResultCodeDescription | String | False |
Field containing GatewayResultCodeDescription information. | |
| GatewayRefDetails | String | False |
Field containing GatewayRefDetails information. | |
| OrderPaymentSummaryId | String | False |
ID of the OrderPaymentSummary associated with this record. | |
| IpAddress | String | False |
Field containing IpAddress information. | |
| MacAddress | String | False |
Field containing MacAddress information. | |
| Phone | String | False |
Phone number for the contact or account. | |
| String | False |
Email address for the contact or person account. | ||
| PaymentGatewayId | String | False |
ID of the PaymentGateway associated with this record. | |
| PaymentMethodId | String | False |
ID of the payment method used. | |
| TotalApplied | Decimal | True |
Field containing TotalApplied information. | |
| TotalUnapplied | Decimal | True |
Field containing TotalUnapplied information. | |
| NetApplied | Decimal | True |
Field containing NetApplied information. | |
| Balance | Decimal | True |
Field containing Balance information. | |
| TotalRefundApplied | Decimal | True |
Total amount of refunds applied against this payment. | |
| TotalRefundUnapplied | Decimal | True |
Total amount of refunds not yet applied against this payment. | |
| NetRefundApplied | Decimal | True |
Net amount of refunds applied against this payment. | |
| PaymentIntentGuid | String | False |
ID of the PaymentIntentGu associated with this record. | |
| TotalPaymentCreditApplied | Decimal | True |
Total amount of payment credit applied against this payment. | |
| TotalPaymentCreditUnapplied | Decimal | True |
Total amount of payment credit not yet applied against this payment. | |
| NetPaymentCreditApplied | Decimal | True |
Net amount of payment credit applied against this payment. | |
| SystemModstamp | Datetime | True |
Date and time when the record was last modified by a user or by an automated process. | |
| LastModifiedDate | Datetime | True |
Date and time when the record was last modified. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| SOQL | String |
Specifies the SOQL query to execute against the Salesforce servers. If this pseudo column is set from the WHERE clause it will take precedence over the original query. |
| ExternalIdColumn | String |
Specifies the external Id column to use if performing an insert. If this value is specified, upsert will be used when the INSERT command is called. |
| FilterScope | String |
Optional scope to limit the records returned from queries. This property can take one of these values: Delegated, Everything, Mine, MineAndMyGroups, My_Territory, My_Team_Territory, or Team. |