afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/Refund.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "Refund - Data API",
  "description": "Represents a refund made against a payment. This object is available in API version 48.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "AccountId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The customer account containing the payment that this refund targets. This is a relationship field.",
      "relationship_name": "Account",
      "relationship_type": "Lookup",
      "refers_to": "Account"
    },
    "Amount": {
      "type": "currency",
      "properties": "Create, Filter, Sort, Update",
      "description": "Total amount of this refund."
    },
    "Balance": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "Remaining balance following refund line applications. Equal to the Amount field – the Net Applied field."
    },
    "CancellationDate": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "The date that the refund was canceled. This is a required parameter for void services."
    },
    "CancellationEffectiveDate": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "The date that the cancellation of this refund takes effect."
    },
    "CancellationGatewayDate": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "The date when the cancellation transaction was processed in the payment gateway."
    },
    "CancellationGatewayRefNumber": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Unique ID for the cancellation transaction. Generated by the payment gateway."
    },
    "CancellationGatewayResultCode": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Gateway-specific result code for the cancellation transaction. Generated by the payment gateway. Must be mapped to a Salesforce-specific result code."
    },
    "CancellationSfResultCode": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Salesforce-specific result code that can map to one or more gateway result codes. We recommend configuring the payment gateway adapter layer to map gateway result codes to the appropriate Salesforce result code."
    },
    "ClientContext": {
      "type": "textarea",
      "properties": "Nillable",
      "description": "Contains caller context for payment APIs. Useful for re-establishing context during an asynchronous payment transaction."
    },
    "Comments": {
      "type": "textarea",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "Users can add comments to provide additional details about a record. Maximum of 1000 characters."
    },
    "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 group record."
    },
    "Date": {
      "type": "dateTime",
      "properties": "Create, Defaulted on create, Filter, Nillable, Sort, Update",
      "description": "The date and time that this refund was created."
    },
    "EffectiveDate": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "Defines the date and time when the refund application becomes effective."
    },
    "Email": {
      "type": "email",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Email address of the person who initiated the refund."
    },
    "GatewayDate": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "The date that a successful gateway communication caused the creation of this refund."
    },
    "GatewayRefNumber": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Unique transaction ID created by the payment gateway."
    },
    "GatewayResultCode": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Gateway-specific result code. Must be mapped to a Salesforce-specific result code."
    },
    "GatewayResultCodeDescription": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Description of the GatewayResultCode. Useful for providing additional context as to why the gateway returned a specific result code."
    },
    "ImpactAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "Shows the refund’s financial impact against the customer’s accounts receivable. If the refund amount is valid, it equals the Amount field. Equals 0 when the refund amount is void. Has a null value when the refund is canceled."
    },
    "IpAddress": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The IP address of the person who initiated the payment."
    },
    "LastReferencedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp for when the current user last viewed a record related to this record."
    },
    "LastViewedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp for when the current user last viewed this record. If this value is null, this record can have been referenced (LastReferencedDate) but not viewed."
    },
    "MacAddress": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The MAC address of the person who initiated the refund."
    },
    "NetApplied": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "Equals the Total Applied field minus the Total Unapplied field."
    },
    "OrderPaymentSummaryId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Order payment summary record that shows the balances of each authorization, capture, and refund made against an order."
    },
    "PaymentGatewayId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The payment gateway used to process this refund. This is a relationship field.",
      "relationship_name": "PaymentGateway",
      "relationship_type": "Lookup",
      "refers_to": "PaymentGateway"
    },
    "PaymentGroupId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The payment group for the payment being refunded. This is a relationship field.",
      "relationship_name": "PaymentGroup",
      "relationship_type": "Lookup",
      "refers_to": "PaymentGroup"
    },
    "PaymentID": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "ID of the payment record. This field is a relationship field.",
      "relationship_name": "Payment",
      "relationship_type": "Lookup",
      "refers_to": "Payment"
    },
    "PaymentIntentID": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "ID of the payment intent record. This field is a relationship field.",
      "relationship_name": "PaymentIntent",
      "relationship_type": "Lookup",
      "refers_to": "PaymentIntent"
    },
    "PaymentMethodId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The payment method used to create the payment being refunded. This is a relationship field.",
      "relationship_name": "PaymentMethod",
      "relationship_type": "Lookup",
      "refers_to": "PaymentMethod"
    },
    "Phone": {
      "type": "phone",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Phone number of the customer who initiated the refund."
    },
    "ProcessingMode": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort",
      "description": "Defines whether the payment has been made outside of the payment platform. Possible values are: External: Transactions happened outside of the Salesforce payments platform. Salesforce: Salesforce made and recorded an external call to the payment gateway."
    },
    "RefundNumber": {
      "type": "string",
      "properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
      "description": "System-created unique ID for this refund."
    },
    "SfResultCode": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "Salesforce-specific result code that can map to one or more gateway result codes. We recommend configuring the payment gateway adapter layer to map gateway result codes to the appropriate Salesforce result code. Possible values are: Decline: The gateway call failed but the transaction can be attempted again. For example, the customer had insufficient funds or briefly lost their connection. Indeterminate: The gateway didn’t respond to the call. This response usually happens when Salesforce times out while waiting for a response from the gateway. PermanentFail: The gateway call failed and can’t work even if tried again. Gateway calls fail permanently for one of two reasons: Hard Decline: The customer’s payment account has been closed or terminated. Fraud: The gateway recognized the payment or payment method as known fraud. RequiresReview: The customer bank requires more information before completing the payment. Success: The gateway call succeeded. SystemError: Salesforce ended the payment request before receiving a response. For example, Salesforce lost credentials or access to its server. Salesforce ends payment calls if it doesn’t receive a response from the gateway within two minutes. ValidationError: Customer payment data was incorrect, such as a misspelling in the credit card address or an incorrect CVV."
    },
    "Status": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "Defines the state of this refund. Possible values are: Canceled: This refund has been voided and can no longer be allocated. Draft: The refund can be edited before posting it and allocating it to a target. Processed: This refund has been finalized and can be allocated against a target. Users can manually change the Status field’s values as follows: Draft to Processed Processed to Canceled Draft to Canceled"
    },
    "TotalApplied": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The sum of Amount fields across all of this refund’s applied refund lines."
    },
    "TotalUnapplied": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The sum of Amount fields across all of this refund’s unapplied refund lines."
    },
    "Type": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "Defines how this refund is used. Possible values are: NonReferenced: Standalone refund not linked to any payment. Referenced: Refund made against a payment."
    }
  },
  "special_access_rules": "To access Salesforce Payments objects with the API, your org must have one or more of these licenses: Salesforce Payments, Salesforce Order Management, B2B Commerce, or D2C Commerce. Salesforce Payments objects are available only in Lightning Experience.",
  "wsdl_segment": "```xml\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n<simpleType name=\"QueryLocator\">\n  <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n  <sequence>\n    <element name=\"done\" type=\"xsd:boolean\"/>\n    <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n    <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n    <element name=\"size\" type=\"xsd:int\"/>\n  </sequence>\n</complexType>\n<complexType name=\"Refund\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"Account\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Account\"/>\n        <element name=\"AccountId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"Amount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"Balance\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"CancellationDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"CancellationEffectiveDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"CancellationGatewayDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"CancellationGatewayRefNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CancellationGatewayResultCode\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CancellationSfResultCode\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ClientContext\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Comments\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Date\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"DestinationFinanceTransactions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"EffectiveDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Email\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"FinanceBalanceSnapshots\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"FinanceTransactions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"GatewayDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"GatewayRefNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"GatewayResultCode\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"GatewayResultCodeDescription\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ImpactAmount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"IpAddress\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"MacAddress\" nil
  "field_reference": {
    "AccountId": {
      "field_label": "Account ID",
      "type": "reference",
      "length": "18"
    },
    "Amount": {
      "field_label": "Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "Balance": {
      "field_label": "Balance",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "CancellationDate": {
      "field_label": "Cancellation Date",
      "type": "datetime"
    },
    "CancellationEffectiveDate": {
      "field_label": "Cancellation Effective Date",
      "type": "datetime"
    },
    "CancellationGatewayDate": {
      "field_label": "Cancellation Gateway Date",
      "type": "datetime"
    },
    "CancellationGatewayRefNumber": {
      "field_label": "Cancellation Gateway Reference Number",
      "type": "string",
      "length": "255"
    },
    "CancellationGatewayResultCode": {
      "field_label": "Cancellation Gateway Result Code",
      "type": "string",
      "length": "64"
    },
    "CancellationSfResultCode": {
      "field_label": "Cancellation Salesforce Result Code",
      "type": "string",
      "length": "64"
    },
    "ClientContext": {
      "field_label": "Client Context",
      "type": "textarea",
      "length": "2000"
    },
    "Comments": {
      "field_label": "Comments",
      "type": "textarea",
      "length": "1000"
    },
    "CorporateCurrencyCnvAmount": {
      "field_label": "Corporate Currency Converted Amount",
      "type": "double",
      "precision": "18",
      "scale": "6"
    },
    "CorporateCurrencyCvsnDate": {
      "field_label": "Corporate Currency Conversion Date",
      "type": "date"
    },
    "CorporateCurrencyCvsnRate": {
      "field_label": "Corporate Currency Conversion Rate",
      "type": "double",
      "precision": "18",
      "scale": "10"
    },
    "CorporateCurrencyIsoCode": {
      "field_label": "Corporate Currency ISO Code",
      "type": "string",
      "length": "40"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "CurrencyIsoCode": {
      "field_label": "Currency ISO Code",
      "type": "picklist",
      "length": "3"
    },
    "Date": {
      "field_label": "Date",
      "type": "datetime"
    },
    "EffectiveDate": {
      "field_label": "Effective Date",
      "type": "datetime"
    },
    "Email": {
      "field_label": "Audit Email",
      "type": "email",
      "length": "80"
    },
    "FunctionalCurrencyCnvAmount": {
      "field_label": "Functional Currency Converted Amount",
      "type": "double",
      "precision": "18",
      "scale": "6"
    },
    "FunctionalCurrencyCvsnDate": {
      "field_label": "Functional Currency Conversion Date",
      "type": "date"
    },
    "FunctionalCurrencyCvsnRate": {
      "field_label": "Functional Currency Conversion Rate",
      "type": "double",
      "precision": "18",
      "scale": "10"
    },
    "FunctionalCurrencyIsoCode": {
      "field_label": "Functional Currency ISO Code",
      "type": "string",
      "length": "40"
    },
    "GatewayDate": {
      "field_label": "Gateway Date",
      "type": "datetime"
    },
    "GatewayRefNumber": {
      "field_label": "Gateway Reference Number",
      "type": "string",
      "length": "255"
    },
    "GatewayResultCode": {
      "field_label": "Gateway Result Code",
      "type": "string",
      "length": "64"
    },
    "GatewayResultCodeDescription": {
      "field_label": "Gateway Result Code Description",
      "type": "string",
      "length": "255"
    },
    "Id": {
      "field_label": "Refund ID",
      "type": "id",
      "length": "18"
    },
    "ImpactAmount": {
      "field_label": "Impact Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "IpAddress": {
      "field_label": "IP Address",
      "type": "string",
      "length": "39"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "LegalEntityAccountingPeriodId": {
      "field_label": "Legal Entity Accounting Period ID",
      "type": "reference",
      "length": "18"
    },
    "LegalEntityId": {
      "field_label": "Legal Entity ID",
      "type": "reference",
      "length": "18"
    },
    "MacAddress": {
      "field_label": "MAC Address",
      "type": "string",
      "length": "32"
    },
    "NetApplied": {
      "field_label": "Net Applied",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "OrderPaymentSummaryId": {
      "field_label": "Order Payment Summary ID",
      "type": "reference",
      "length": "18"
    },
    "PaymentGatewayId": {
      "field_label": "Payment Gateway ID",
      "type": "reference",
      "length": "18"
    },
    "PaymentGroupId": {
      "field_label": "Payment Group ID",
      "type": "reference",
      "length": "18"
    },
    "PaymentId": {
      "field_label": "Payment ID",
      "type": "reference",
      "length": "18"
    },
    "PaymentIntentId": {
      "field_label": "Payment Intent ID",
      "type": "reference",
      "length": "18"
    },
    "PaymentMethodId": {
      "field_label": "Payment Method ID",
      "type": "reference",
      "length": "18"
    },
    "Phone": {
      "field_label": "Phone",
      "type": "phone",
      "length": "40"
    },
    "ProcessingMode": {
      "field_label": "Processing Mode",
      "type": "picklist",
      "length": "255"
    },
    "RefundNumber": {
      "field_label": "Refund Number",
      "type": "string",
      "length": "255"
    },
    "SfResultCode": {
      "field_label": "Salesforce Result Code",
      "type": "picklist",
      "length": "255"
    },
    "Status": {
      "field_label": "Status",
      "type": "picklist",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "TotalApplied": {
      "field_label": "Total Applied",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "TotalUnapplied": {
      "field_label": "Total Unapplied",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "Type": {
      "field_label": "Type",
      "type": "picklist",
      "length": "255"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "precision",
    "scale"
  ]
}