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

{
  "sections": [
    "title",
    "description",
    "fields",
    "usage",
    "associated_objects"
  ],
  "title": "SalesforceContract - Data API",
  "description": "Read-only virtual object used in the Your Account App. Represents contract information related to your organization’s Salesforce subscription.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "AutoRenewCode": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Determines if contract renews automatically Possible values are: No Yes"
    },
    "BillingAddressCity": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Details for the billing address. Maximum size is 40 characters."
    },
    "BillingAddressCountry": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Details for the billing address of this contract. Maximum size is 80 characters."
    },
    "BillingAddressPostalCode": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Details for the billing address of this contract. Maximum size is 20 characters."
    },
    "BillingAddressState": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Details for the billing address of this contract. Maximum size is 80 characters."
    },
    "BillingAddressStreet": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Street address for the billing address of this contract."
    },
    "BillingCompany": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Name of the billing company."
    },
    "BillingEmail": {
      "type": "email",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Email address for billing this contract."
    },
    "BillingFrequency": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Define billing periods."
    },
    "BillingName": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Contact name for this contract."
    },
    "BillingPhone": {
      "type": "phone",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Phone number for billing this contract."
    },
    "ContractId": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "ID for this contract."
    },
    "ContractNumber": {
      "type": "string",
      "properties": "Filter, Group, idLookup, Nillable, Sort",
      "description": "Number of the contract."
    },
    "CreditCardExpirationMonth": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Month the credit card expires."
    },
    "CreditCardExpirationYear": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Year the credit card expires."
    },
    "CreditCardNumber": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "16-digit credit card number."
    },
    "CreditCardType": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Credit card provider. Possible values are: AmericanExpress— JCB MasterCard Visa"
    },
    "EndDate": {
      "type": "date",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "End date of the contract."
    },
    "ExternalId": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "External reference ID set by Salesforce."
    },
    "FirstNameOnCreditCard": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Cardholder’s first name on the credit card."
    },
    "LastNameOnCreditCard": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Cardholder’s last name on the credit card."
    },
    "PaymentTerm": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Payment terms definition. Possible values are: Net0—Due upon receipt Net10—DD-Germany: Net 10 Net30— Net30EOM—JP-Net 30 EOM Net45— Net60— Net60EOM—JP-Net 60 EOM"
    },
    "PaymentType": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Payment type definition. Possible values are: Check CreditCard— DirectDebit— WireTransfer—"
    },
    "SalesforceContractStatus": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The status of the contract Possible values are: Activated Draft Expired Terminated inApproval—"
    },
    "ShippingAddressCity": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Details of the shipping address. City maximum size is 40 characters."
    },
    "ShippingAddressCountry": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Details of the shipping address. Country maximum size is 80 characters."
    },
    "ShippingAddressPostalCode": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Details of the shipping address. Postal code maximum size is 20 characters."
    },
    "ShippingAddressState": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Details of the shipping address. State maximum size is 80 characters."
    },
    "ShippingAddressStreet": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The street address of the shipping address. Maximum of 255 characters."
    },
    "StartDate": {
      "type": "date",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Start date of the contract."
    },
    "SubscriptionDaysLeft": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Days remaining for this subscription."
    }
  },
  "usage": "Used by Your Account to manage contracts related to your organization’s Salesforce subscription. Read-only.",
  "associated_objects": "This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later."
}