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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "field_reference"
  ],
  "title": "PaymentCreditTransaction - Data API",
  "description": "A payment credit transaction. This object is available in API version 65.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "refers_to",
    "relationship_type"
  ],
  "fields": {
    "Amount": {
      "type": "currency",
      "properties": "Create, Filter, Sort",
      "description": "Amount of the payment credit transaction. This is a required field."
    },
    "AssociatedAccountId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort",
      "description": "ID of the customer account. This field is a relationship field.",
      "relationship_name": "AssociatedAccount",
      "refers_to": "Account"
    },
    "ClientContext": {
      "type": "textarea",
      "properties": "Nillable",
      "description": "Additional information about the payment credit transaction."
    },
    "CurrencyIsoCode": {
      "type": "picklist",
      "properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "Contains the ISO code for any currency allowed by the organization. Possible values are: EUR—Euro GBP—British Pound USD—U.S. Dollar The default value is USD."
    },
    "ExternalReference": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Reference ID used to track the payment credit transaction."
    },
    "LastReferencedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "Timestamp for when the current user last viewed a record related to this record."
    },
    "LastViewedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "Timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed."
    },
    "PaymentCreditId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort",
      "description": "ID of the payment credit. This field is a relationship field. This is a required field.",
      "relationship_name": "PaymentCredit",
      "relationship_type": "Master-detail",
      "refers_to": "PaymentCredit (the master object)"
    },
    "PaymentCreditTransactionNumber": {
      "type": "string",
      "properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
      "description": "Number of the payment credit transaction. This field is automatically generated. Example: PCT-{000000000}."
    },
    "ProcessingMode": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "Credit transaction processing mode. Possible values are: External Salesforce This is a required field."
    },
    "Status": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "A static enum showing the status of the credit transaction. Possible values are: Canceled Draft Failed Pending Processed"
    },
    "TransactionMessage": {
      "type": "string",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "Message describing the transaction."
    }
  },
  "special_access_rules": "This object is only available in Salesforce Order Management orgs or if the B2B Commerce or D2C Commerce license is enabled. Users require the PaymentCredit and PaymentPlatform permission sets.\n\nThis object is only available in Salesforce Order\n         Management orgs or if the B2B Commerce or D2C Commerce license is enabled. Users require\n         the PaymentCredit and PaymentPlatform permission sets.",
  "field_reference": {
    "Amount": {
      "field_label": "Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "AssociatedAccountId": {
      "field_label": "Account ID",
      "type": "reference",
      "length": "18"
    },
    "ClientContext": {
      "field_label": "Client Context",
      "type": "textarea",
      "length": "2000"
    },
    "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"
    },
    "ExternalReference": {
      "field_label": "External Reference",
      "type": "string",
      "length": "255"
    },
    "Id": {
      "field_label": "Payment Credit Transaction ID",
      "type": "id",
      "length": "18"
    },
    "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"
    },
    "PaymentCreditId": {
      "field_label": "Payment Credit ID",
      "type": "reference",
      "length": "18"
    },
    "PaymentCreditTransactionNumber": {
      "field_label": "Payment Credit Transaction Number",
      "type": "string",
      "length": "255"
    },
    "ProcessingMode": {
      "field_label": "Processing Mode",
      "type": "picklist",
      "length": "255"
    },
    "Status": {
      "field_label": "Status",
      "type": "picklist",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "TransactionMessage": {
      "field_label": "Transaction Message",
      "type": "string",
      "length": "255"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "precision",
    "scale",
    "length"
  ]
}