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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "usage",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "RefundLinePayment - Data API",
  "description": "A refund line that has been applied to 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": {
    "Amount": {
      "type": "currency",
      "properties": "Create, Filter, Sort",
      "description": "The total amount applied to or unapplied from a payment by the refund line."
    },
    "AppliedDate": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort",
      "description": "The date that the refund was applied to the linked payment."
    },
    "AssociatedAccountId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "The account for the payment that received the refund. This is a relationship field.",
      "relationship_name": "AssociatedAccount",
      "relationship_type": "Lookup",
      "refers_to": "Account"
    },
    "AssociatedRefundLinePaymentId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "The refundLine that was unapplied. Populated only when RefundLinePayment’s Type has a value of Unapplied. This is a relationship field.",
      "relationship_name": "AssociatedRefundLinePayment",
      "relationship_type": "Lookup",
      "refers_to": "RefundLinePayment"
    },
    "Comments": {
      "type": "textarea",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "Users can add comments to provide additional information on the refund line payment."
    },
    "Date": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort",
      "description": "By default, the day the refund line payment record was created. Users can also enter a different date."
    },
    "EffectiveDate": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort",
      "description": "Defines the date and time when the refund line application or unapplication becomes effective."
    },
    "EffectiveImpactAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "Shows how this payment refund line impacts a customer’s accounts receivable. This value is positive when RefundLinePayment’s Type field is Applied, and negative when RefundLinePayment’s Type is Unapplied. If there’s an unapplied line related to this record, EffectiveImpactAmount has a value of 0. Note: EffectiveImpactAmount evaluates only the applied and unapplied line pair. Therefore, the effective impact amount could be different for different lines within the same refund."
    },
    "HasBeenUnapplied": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort",
      "description": "Shows whether this refund line has been unapplied. Possible values are: No"
    },
    "ImpactAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "Shows how this payment refund line impacts a customer’s accounts receivable. This value is positive when RefundLinePayment’s Type field is Applied, and negative when RefundLinePayment’s Type is Unapplied."
    },
    "PaymentBalance": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The payment record’s balance following the application or unapplication of this refund line."
    },
    "PaymentId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "The payment record that this refund line targets. Refund applications and unapplications are made against this payment. This is a relationship field.",
      "relationship_name": "Payment",
      "relationship_type": "Lookup",
      "refers_to": "Payment"
    },
    "RefundBalance": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The refund record’s balance following the application or unapplication of this payment refund line."
    },
    "RefundId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "The parent refund of this refund line. This is a relationship field.",
      "relationship_name": "Refund",
      "relationship_type": "Lookup",
      "refers_to": "Refund"
    },
    "RefundLinePaymentNumber": {
      "type": "string",
      "properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
      "description": "System-created unique ID for this refund line."
    },
    "Type": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort",
      "description": "Defines whether this line represents a refund that’s been applied or unapplied from a payment. Possible values are: Applied"
    },
    "UnappliedDate": {
      "type": "dateTime",
      "properties": "Create, Filter, Nillable, Sort",
      "description": "The date that this refund line was unapplied from a payment."
    }
  },
  "special_access_rules": "To access Commerce Payments entities, your org must have a Salesforce Order Management license with the Payment Platform org permission activated.",
  "usage": "When you’re ready to apply a refund’s balance to a payment, create a refund line (RefundLinePayment). The refund line represents the balance taken from the payment and applied toward the invoice. You can apply a refund’s balance when you create the refund record or afterward. The refund line must have the same currency as the parent refund. A refund has an amount, which represents the total amount taken from the refund, and a balance, which represents the remaining amount after the refund line has been applied to a payment. A refund’s amount can’t be less than the sum of all of its refund line amounts. You can apply any portion of a refund’s balance to a payment. You can apply a refund to transactions on the same account or to different transacations across different accounts.\n\nWhen you’re ready to apply a refund’s balance to a payment, create a refund line (RefundLinePayment). The refund line represents the balance taken from the payment and applied toward the invoice. You can apply a refund’s balance when you create the refund record or afterward. The refund line must have the same currency as the parent refund.\n\nA refund has an amount, which represents the total amount taken from the refund, and a balance, which represents the remaining amount after the refund line has been applied to a payment. A refund’s amount can’t be less than the sum of all of its refund line amounts. You can apply any portion of a refund’s balance to a payment.\n\nYou can apply a refund to transactions on the same account or to different transacations across different accounts.",
  "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=\"RefundLinePayment\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"Amount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"AppliedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"AssociatedAccount\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Account\"/>\n        <element name=\"AssociatedAccountId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"AssociatedRefundLinePayment\" nillable=\"true\" minOccurs=\"0\" type=\"ens:RefundLinePayment\"/>\n        <element name=\"AssociatedRefundLinePaymentId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\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=\"EffectiveImpactAmount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\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=\"HasBeenUnapplied\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Histories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ImpactAmount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\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=\"ParentFinanceTransactions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"Payment\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Payment\"/>\n        <element name=\"PaymentBalance\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"PaymentId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"Refund\" nillable=\"true\" minOccurs=\"0\" type=\"ens:Refund\"/>\n        <element name=\"RefundBalance\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"RefundId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"RefundLinePaymentNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"RefundLinePayments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"SourceFinanceTransactions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Type\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"UnappliedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n```",
  "field_reference": {
    "Amount": {
      "field_label": "Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "AppliedDate": {
      "field_label": "Applied Date",
      "type": "datetime"
    },
    "AssociatedAccountId": {
      "field_label": "Account ID",
      "type": "reference",
      "length": "18"
    },
    "AssociatedRefundLinePaymentId": {
      "field_label": "Refund Line Payment ID",
      "type": "reference",
      "length": "18"
    },
    "Comments": {
      "field_label": "Comments",
      "type": "textarea",
      "length": "1000"
    },
    "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"
    },
    "EffectiveImpactAmount": {
      "field_label": "Effective Impact Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "HasBeenUnapplied": {
      "field_label": "Has Been Unapplied",
      "type": "picklist",
      "length": "255"
    },
    "Id": {
      "field_label": "Refund Line Payment ID",
      "type": "id",
      "length": "18"
    },
    "ImpactAmount": {
      "field_label": "Impact Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "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"
    },
    "LegalEntityAccountingPeriodId": {
      "field_label": "Legal Entity Accounting Period ID",
      "type": "reference",
      "length": "18"
    },
    "LegalEntityId": {
      "field_label": "Legal Entity ID",
      "type": "reference",
      "length": "18"
    },
    "PaymentBalance": {
      "field_label": "Payment Balance",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "PaymentId": {
      "field_label": "Payment ID",
      "type": "reference",
      "length": "18"
    },
    "RefundBalance": {
      "field_label": "Refund Balance",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "RefundId": {
      "field_label": "Refund ID",
      "type": "reference",
      "length": "18"
    },
    "RefundLinePaymentNumber": {
      "field_label": "Refund Line Payment Number",
      "type": "string",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "Type": {
      "field_label": "Type",
      "type": "picklist",
      "length": "255"
    },
    "UnappliedDate": {
      "field_label": "Unapplied Date",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "precision",
    "scale",
    "length"
  ]
}