POST api/deposit/schemes/create

Request Information

URI Parameters

None.

Body Parameters

SetDepositSchemeDataContract
NameDescriptionTypeAdditional information
SchemeName

string

None.

SchemeType

string

None.

ReferenceNumber

string

None.

DepositAccountId

integer

None.

BankAccountName

string

None.

SortCode

string

None.

AccountNumber

string

None.

Id

integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "SchemeName": "sample string 1",
  "SchemeType": "sample string 2",
  "ReferenceNumber": "sample string 3",
  "DepositAccountId": 1,
  "BankAccountName": "sample string 4",
  "SortCode": "sample string 5",
  "AccountNumber": "sample string 6",
  "Id": 7
}

Response Information

Resource Description

DepositSchemeDataContract
NameDescriptionTypeAdditional information
SchemeName

string

None.

SchemeType

string

None.

ReferenceNumber

string

None.

DepositClientAccountId

integer

None.

AccountLedger

AccountDataContract

None.

CreatedDate

date

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "SchemeName": "sample string 1",
  "SchemeType": "sample string 2",
  "ReferenceNumber": "sample string 3",
  "DepositClientAccountId": 1,
  "AccountLedger": {
    "Name": "sample string 1",
    "AccountType": "sample string 2",
    "TotalBalance": 3.0,
    "TotalUnclearedBalance": 4.0,
    "TotalAvailableBalance": 5.0,
    "AccountPosition": 6.0,
    "DepositHeldBalance": 7.0,
    "Status": "sample string 8",
    "ChildAccounts": [
      1,
      2
    ],
    "AccountGroupId": 1,
    "Fees": [
      {
        "Name": "sample string 1",
        "FeeValueType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "FeeCategoryType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "FeeChargeType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "FeeLiabilityType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "FeeFrequency": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "FeePercentageOfType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "VatRateType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "ApplyTax": true,
        "VatValue": 3.1,
        "DefaultValue": 4.1,
        "ScaleableFees": [
          {
            "Name": "sample string 1",
            "Threshold": 2.1,
            "Value": 3.1,
            "ThresholdType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "ValueType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "CreatedDate": "2025-07-02T04:40:15.5563067Z",
            "CreatedBy": {
              "Initials": "sample string 1",
              "ContactName": "sample string 2",
              "Gender": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Title": "sample string 3",
              "FirstName": "sample string 4",
              "LastName": "sample string 5",
              "PrimaryTelephone": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "PrimaryEmail": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "JobTitle": "sample string 6",
              "Id": 7
            },
            "Id": 5
          },
          {
            "Name": "sample string 1",
            "Threshold": 2.1,
            "Value": 3.1,
            "ThresholdType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "ValueType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "CreatedDate": "2025-07-02T04:40:15.5563067Z",
            "CreatedBy": {
              "Initials": "sample string 1",
              "ContactName": "sample string 2",
              "Gender": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Title": "sample string 3",
              "FirstName": "sample string 4",
              "LastName": "sample string 5",
              "PrimaryTelephone": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "PrimaryEmail": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "JobTitle": "sample string 6",
              "Id": 7
            },
            "Id": 5
          }
        ],
        "AdditionalFees": [
          {
            "Name": "sample string 1",
            "Threshold": 2.1,
            "Value": 3.1,
            "ThresholdType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "ValueType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "CreatedDate": "2025-07-02T04:40:15.5563067Z",
            "CreatedBy": {
              "Initials": "sample string 1",
              "ContactName": "sample string 2",
              "Gender": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Title": "sample string 3",
              "FirstName": "sample string 4",
              "LastName": "sample string 5",
              "PrimaryTelephone": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "PrimaryEmail": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "JobTitle": "sample string 6",
              "Id": 7
            },
            "Id": 5
          },
          {
            "Name": "sample string 1",
            "Threshold": 2.1,
            "Value": 3.1,
            "ThresholdType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "ValueType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "CreatedDate": "2025-07-02T04:40:15.5563067Z",
            "CreatedBy": {
              "Initials": "sample string 1",
              "ContactName": "sample string 2",
              "Gender": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Title": "sample string 3",
              "FirstName": "sample string 4",
              "LastName": "sample string 5",
              "PrimaryTelephone": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "PrimaryEmail": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "JobTitle": "sample string 6",
              "Id": 7
            },
            "Id": 5
          }
        ],
        "Notes": "sample string 5",
        "TransactionType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "IsDefault": true,
        "CalculatedValue": 7.1,
        "AutoApply": true,
        "CreatedDate": "2025-07-02T04:40:15.5563067Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 10
      },
      {
        "Name": "sample string 1",
        "FeeValueType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "FeeCategoryType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "FeeChargeType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "FeeLiabilityType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "FeeFrequency": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "FeePercentageOfType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "VatRateType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "ApplyTax": true,
        "VatValue": 3.1,
        "DefaultValue": 4.1,
        "ScaleableFees": [
          {
            "Name": "sample string 1",
            "Threshold": 2.1,
            "Value": 3.1,
            "ThresholdType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "ValueType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "CreatedDate": "2025-07-02T04:40:15.5563067Z",
            "CreatedBy": {
              "Initials": "sample string 1",
              "ContactName": "sample string 2",
              "Gender": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Title": "sample string 3",
              "FirstName": "sample string 4",
              "LastName": "sample string 5",
              "PrimaryTelephone": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "PrimaryEmail": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "JobTitle": "sample string 6",
              "Id": 7
            },
            "Id": 5
          },
          {
            "Name": "sample string 1",
            "Threshold": 2.1,
            "Value": 3.1,
            "ThresholdType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "ValueType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "CreatedDate": "2025-07-02T04:40:15.5563067Z",
            "CreatedBy": {
              "Initials": "sample string 1",
              "ContactName": "sample string 2",
              "Gender": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Title": "sample string 3",
              "FirstName": "sample string 4",
              "LastName": "sample string 5",
              "PrimaryTelephone": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "PrimaryEmail": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "JobTitle": "sample string 6",
              "Id": 7
            },
            "Id": 5
          }
        ],
        "AdditionalFees": [
          {
            "Name": "sample string 1",
            "Threshold": 2.1,
            "Value": 3.1,
            "ThresholdType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "ValueType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "CreatedDate": "2025-07-02T04:40:15.5563067Z",
            "CreatedBy": {
              "Initials": "sample string 1",
              "ContactName": "sample string 2",
              "Gender": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Title": "sample string 3",
              "FirstName": "sample string 4",
              "LastName": "sample string 5",
              "PrimaryTelephone": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "PrimaryEmail": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "JobTitle": "sample string 6",
              "Id": 7
            },
            "Id": 5
          },
          {
            "Name": "sample string 1",
            "Threshold": 2.1,
            "Value": 3.1,
            "ThresholdType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "ValueType": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "CreatedDate": "2025-07-02T04:40:15.5563067Z",
            "CreatedBy": {
              "Initials": "sample string 1",
              "ContactName": "sample string 2",
              "Gender": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Title": "sample string 3",
              "FirstName": "sample string 4",
              "LastName": "sample string 5",
              "PrimaryTelephone": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "PrimaryEmail": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "JobTitle": "sample string 6",
              "Id": 7
            },
            "Id": 5
          }
        ],
        "Notes": "sample string 5",
        "TransactionType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "IsDefault": true,
        "CalculatedValue": 7.1,
        "AutoApply": true,
        "CreatedDate": "2025-07-02T04:40:15.5563067Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 10
      }
    ],
    "Id": 9
  },
  "CreatedDate": "2025-07-02T04:40:15.5563067Z",
  "Id": 4
}