Salesforce · JSON Structure

Salesforce Create Commitments Request Structure

Type: object Properties: 2 Required: 2
Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

CreateCommitmentsRequest is a JSON Structure definition published by Salesforce, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

processingOptions commitments

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑
{
  "type": "object",
  "name": "CreateCommitmentsRequest",
  "properties": {
    "processingOptions": {
      "type": "object",
      "properties": {
        "donorOptions": {
          "type": "object",
          "properties": {
            "defaultUpdateLogic": {
              "type": "string"
            }
          },
          "required": [
            "defaultUpdateLogic"
          ]
        }
      },
      "required": [
        "donorOptions"
      ]
    },
    "commitments": {
      "type": "array",
      "description": "",
      "items": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "number"
          },
          "currencyIsoCode": {
            "type": "string"
          },
          "transactionPeriod": {
            "type": "string"
          },
          "transactionInterval": {
            "type": "integer"
          },
          "transactionDay": {
            "type": "string"
          },
          "startDate": {
            "type": "string"
          },
          "endDate": {
            "type": "string"
          },
          "campaign": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              }
            },
            "required": [
              "id"
            ]
          },
          "outreachSourceCode": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "sourceCode": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "sourceCode"
            ]
          },
          "donor": {
            "type": "object",
            "properties": {
              "donorType": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "firstName": {
                "type": "string"
              },
              "lastName": {
                "type": "string"
              },
              "phone": {
                "type": "string"
              },
              "email": {
                "type": "string"
              },
              "address": {
                "type": "array",
                "description": "",
                "items": {
                  "type": "object",
                  "properties": {
                    "addressType": {
                      "type": "object"
                    },
                    "street": {
                      "type": "object"
                    },
                    "city": {
                      "type": "object"
                    },
                    "state": {
                      "type": "object"
                    },
                    "postalCode": {
                      "type": "object"
                    },
                    "country": {
                      "type": "object"
                    }
                  },
                  "required": [
                    "addressType",
                    "street",
                    "city",
                    "state",
                    "postalCode",
                    "country"
                  ]
                }
              },
              "accountCustomFields": {
                "type": "array",
                "description": "",
                "items": {
                  "type": "object",
                  "properties": {
                    "fieldName": {
                      "type": "object"
                    },
                    "fieldValue": {
                      "type": "object"
                    }
                  },
                  "required": [
                    "fieldName",
                    "fieldValue"
                  ]
                }
              }
            },
            "required": [
              "donorType",
              "id",
              "firstName",
              "lastName",
              "phone",
              "email",
              "address",
              "accountCustomFields"
            ]
          },
          "paymentInstrument": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string"
              },
              "accountHolderName": {
                "type": "string"
              },
              "expiryMonth": {
                "type": "string"
              },
              "expiryYear": {
                "type": "string"
              },
              "last4": {
                "type": "string"
              },
              "cardBrand": {
                "type": "string"
              },
              "bankName": {
                "type": "string"
              },
              "digitalWalletProvider": {
                "type": "string"
              },
              "bankAccountHolderType": {
                "type": "string"
              },
              "bankAccountType": {
                "type": "string"
              },
              "bankAccountNumber": {
                "type": "string"
              },
              "bankCode": {
                "type": "string"
              },
              "gatewayName": {
                "type": "string"
              },
              "processorName": {
                "type": "string"
              },
              "processorPaymentReference": {
                "type": "string"
              },
              "gatewayReference": {
                "type": "string"
              }
            },
            "required": [
              "type",
              "accountHolderName",
              "expiryMonth",
              "expiryYear",
              "last4",
              "cardBrand",
              "bankName",
              "digitalWalletProvider",
              "bankAccountHolderType",
              "bankAccountType",
              "bankAccountNumber",
              "bankCode",
              "gatewayName",
              "processorName",
              "processorPaymentReference",
              "gatewayReference"
            ]
          },
          "designations": {
            "type": "array",
            "description": "",
            "items": {
              "type": "object",
              "properties": {
                "designationId": {
                  "type": "string"
                },
                "percent": {
                  "type": "integer"
                }
              },
              "required": [
                "designationId",
                "percent"
              ]
            }
          },
          "firstTransaction": {
            "type": "object",
            "properties": {
              "amount": {
                "type": "number"
              },
              "receivedDate": {
                "type": "string"
              },
              "donorCoverAmount": {
                "type": "number"
              },
              "transactionStatus": {
                "type": "string"
              },
              "gatewayTransactionFee": {
                "type": "number"
              },
              "processorTransactionFee": {
                "type": "number"
              },
              "processorReference": {
                "type": "string"
              },
              "gatewayReference": {
                "type": "string"
              },
              "lastGatewayResponseCode": {
                "type": "string"
              },
              "lastGatewayErrorMessage": {
                "type": "string"
              },
              "lastGatewayProcessedDateTime": {
                "type": "string"
              }
            },
            "required": [
              "amount",
              "receivedDate",
              "donorCoverAmount",
              "transactionStatus",
              "gatewayTransactionFee",
              "processorTransactionFee",
              "processorReference",
              "gatewayReference",
              "lastGatewayResponseCode",
              "lastGatewayErrorMessage",
              "lastGatewayProcessedDateTime"
            ]
          },
          "giftCommitmentCustomFields": {
            "type": "array",
            "description": "",
            "items": {
              "type": "object",
              "properties": {
                "fieldName": {
                  "type": "string"
                },
                "fieldValue": {
                  "type": "string"
                }
              },
              "required": [
                "fieldName",
                "fieldValue"
              ]
            }
          },
          "giftCommitmentScheduleCustomFields": {
            "type": "array",
            "description": "",
            "items": {
              "type": "object",
              "properties": {
                "fieldName": {
                  "type": "string"
                },
                "fieldValue": {
                  "type": "string"
                }
              },
              "required": [
                "fieldName",
                "fieldValue"
              ]
            }
          }
        },
        "required": [
          "amount",
          "currencyIsoCode",
          "transactionPeriod",
          "transactionInterval",
          "transactionDay",
          "startDate",
          "endDate",
          "campaign",
          "outreachSourceCode",
          "donor",
          "paymentInstrument",
          "designations",
          "firstTransaction",
          "giftCommitmentCustomFields",
          "giftCommitmentScheduleCustomFields"
        ]
      }
    }
  },
  "required": [
    "processingOptions",
    "commitments"
  ],
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}