Salesforce · Schema

UpdateCommitmentsRequest

Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

Properties

Name Type Description
amount number
transactionPeriod string
transactionInterval integer
transactionDay string
startDate string
endDate string
campaign object
outreachSourceCode object
donor object
paymentInstrument object
giftCommitmentCustomFields array
giftCommitmentScheduleCustomFields array
View JSON Schema on GitHub

JSON Schema

salesforce-update-commitments-request-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "amount": {
      "type": "number",
      "example": 42.5
    },
    "transactionPeriod": {
      "type": "string",
      "example": "example_value"
    },
    "transactionInterval": {
      "type": "integer",
      "example": 10
    },
    "transactionDay": {
      "type": "string",
      "example": "example_value"
    },
    "startDate": {
      "type": "string",
      "example": "example_value"
    },
    "endDate": {
      "type": "string",
      "example": "example_value"
    },
    "campaign": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "abc123"
        }
      },
      "required": [
        "id"
      ]
    },
    "outreachSourceCode": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "abc123"
        },
        "sourceCode": {
          "type": "string",
          "example": "example_value"
        }
      },
      "required": [
        "id",
        "sourceCode"
      ]
    },
    "donor": {
      "type": "object",
      "properties": {
        "donorType": {
          "type": "string",
          "example": "example_value"
        },
        "organizationName": {
          "type": "string",
          "example": "example_value"
        },
        "firstName": {
          "type": "string",
          "example": "example_value"
        },
        "lastName": {
          "type": "string",
          "example": "example_value"
        },
        "phone": {
          "type": "string",
          "example": "example_value"
        },
        "email": {
          "type": "string",
          "example": "user@example.com"
        },
        "address": {
          "type": "array",
          "description": "",
          "example": [],
          "items": {
            "type": "object",
            "properties": {
              "addressType": {
                "type": "string",
                "example": "example_value"
              },
              "street": {
                "type": "string",
                "example": "example_value"
              },
              "city": {
                "type": "string",
                "example": "example_value"
              },
              "state": {
                "type": "string",
                "example": "example_value"
              },
              "postalCode": {
                "type": "string",
                "example": "example_value"
              },
              "country": {
                "type": "string",
                "example": 42
              }
            },
            "required": [
              "addressType",
              "street",
              "city",
              "state",
              "postalCode",
              "country"
            ]
          }
        },
        "accountCustomFields": {
          "type": "array",
          "description": "",
          "example": 42,
          "items": {
            "type": "object",
            "properties": {
              "fieldName": {
                "type": "string",
                "example": "example_value"
              },
              "fieldValue": {
                "type": "string",
                "example": "example_value"
              }
            },
            "required": [
              "fieldName",
              "fieldValue"
            ]
          }
        }
      },
      "required": [
        "donorType",
        "organizationName",
        "firstName",
        "lastName",
        "phone",
        "email",
        "address",
        "accountCustomFields"
      ]
    },
    "paymentInstrument": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "example": "example_value"
        },
        "accountHolderName": {
          "type": "string",
          "example": 42
        },
        "expiryMonth": {
          "type": "string",
          "example": "example_value"
        },
        "expiryYear": {
          "type": "string",
          "example": "example_value"
        },
        "last4": {
          "type": "string",
          "example": "example_value"
        },
        "cardBrand": {
          "type": "string",
          "example": "example_value"
        },
        "bankName": {
          "type": "string",
          "example": "example_value"
        },
        "digitalWalletProvider": {
          "type": "string",
          "example": "example_value"
        },
        "bankAccountHolderType": {
          "type": "string",
          "example": 42
        },
        "bankAccountType": {
          "type": "string",
          "example": 42
        },
        "bankAccountNumber": {
          "type": "string",
          "example": 42
        },
        "bankCode": {
          "type": "string",
          "example": "example_value"
        },
        "gatewayName": {
          "type": "string",
          "example": "example_value"
        },
        "processorName": {
          "type": "string",
          "example": "example_value"
        },
        "processorPaymentReference": {
          "type": "string",
          "example": "example_value"
        },
        "gatewayReference": {
          "type": "string",
          "example": "example_value"
        }
      },
      "required": [
        "type",
        "accountHolderName",
        "expiryMonth",
        "expiryYear",
        "last4",
        "cardBrand",
        "bankName",
        "digitalWalletProvider",
        "bankAccountHolderType",
        "bankAccountType",
        "bankAccountNumber",
        "bankCode",
        "gatewayName",
        "processorName",
        "processorPaymentReference",
        "gatewayReference"
      ]
    },
    "giftCommitmentCustomFields": {
      "type": "array",
      "description": "",
      "example": [],
      "items": {
        "type": "object",
        "properties": {
          "fieldName": {
            "type": "string",
            "example": "example_value"
          },
          "fieldValue": {
            "type": "string",
            "example": "example_value"
          }
        },
        "required": [
          "fieldName",
          "fieldValue"
        ]
      }
    },
    "giftCommitmentScheduleCustomFields": {
      "type": "array",
      "description": "",
      "example": [],
      "items": {
        "type": "object",
        "properties": {
          "fieldName": {
            "type": "string",
            "example": "example_value"
          },
          "fieldValue": {
            "type": "string",
            "example": "example_value"
          }
        },
        "required": [
          "fieldName",
          "fieldValue"
        ]
      }
    }
  },
  "required": [
    "amount",
    "transactionPeriod",
    "transactionInterval",
    "transactionDay",
    "startDate",
    "endDate",
    "campaign",
    "outreachSourceCode",
    "donor",
    "paymentInstrument",
    "giftCommitmentCustomFields",
    "giftCommitmentScheduleCustomFields"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "UpdateCommitmentsRequest"
}