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

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "field_reference"
  ],
  "title": "PymtSchdDistributionMethod - Data API",
  "description": "Indicates how the total payment is divided into partial payments. This object is available in API version 56.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "Description": {
      "type": "textarea",
      "properties": "Create, Filter, Nillable, Sort, Update",
      "description": "User-entered description of the payment schedule distribution method."
    },
    "DistributionCount": {
      "type": "int",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "The number of payment schedule items for the payment schedule. The payment schedule items are used to distribute the payment schedule’s total payment into partial payments. Possible values are: 1—Full distribution. Currently, each payment schedule must have exactly one payment schedule item."
    },
    "DistributionMethodType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "Distribution method time interval. Possible values are: FullDistribution—The full amount on the payment schedule is distributed to a single payment schedule item. LumpSum—The specified payment amount on the payment schedule is distributed to a single payment schedule item.Available in API version 65.0 and later with Financial Services and Automotive Cloud. Monthly—The specified payment amount on the payment schedule is distributed evenly across multiple monthly payments.Available in API version 65.0 and later with Financial Services and Automotive Cloud. Quarterly—The specified payment amount on the payment schedule is distributed evenly across multiple quarterly payments.Available in API version 65.0 and later with Financial Services and Automotive Cloud. Weekly—The specified payment amount on the payment schedule is distributed evenly across multiple weekly payments.Available in API version 65.0 and later with Financial Services and Automotive Cloud."
    },
    "LastReferencedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp when the current user last accessed this record, a record related to this record, or a list view."
    },
    "LastViewedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it."
    },
    "Name": {
      "type": "string",
      "properties": "Create, Filter, Group, idLookup, Sort, Update",
      "description": "User-entered name for the payment schedule distribution method."
    },
    "OwnerId": {
      "type": "reference",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "ID of the owner of this object. This field is a polymorphic relationship field.",
      "relationship_name": "Owner",
      "relationship_type": "Lookup",
      "refers_to": "Group, User"
    }
  },
  "special_access_rules": "This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the Revenue Cloud Developer Guide.\n\nThis object is available with Subscription Management and Billing (Revenue Cloud).\n\nFor information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the Revenue Cloud Developer Guide.",
  "field_reference": {
    "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"
    },
    "Description": {
      "field_label": "Description",
      "type": "textarea",
      "length": "1000"
    },
    "DistributionCount": {
      "field_label": "Distribution Count",
      "type": "int",
      "digits": "9"
    },
    "DistributionMethodType": {
      "field_label": "Distribution Method Type",
      "type": "picklist",
      "length": "255"
    },
    "Id": {
      "field_label": "Payment Schedule Distribution Method 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"
    },
    "Name": {
      "field_label": "Name",
      "type": "string",
      "length": "255"
    },
    "OwnerId": {
      "field_label": "Owner ID",
      "type": "reference",
      "length": "18"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits"
  ]
}