POST api/account/createsystemaccount
Create a new System account eg. new client account Processes this account API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
None.
Body Parameters
The create sub account system data contract supplied with the request.
CreateSubAccountSystemDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| AccountName |
The account name value. |
string |
None. |
| AccountNumber |
The account number value. |
string |
None. |
| Sortcode |
The sortcode value. |
string |
None. |
| OpeningBalance |
The opening balance value. |
decimal number |
None. |
| IBAN |
The iban value. |
string |
None. |
| BIC |
The bic value. |
string |
None. |
| CountryCode |
The country code value. |
string |
None. |
| BankName |
The bank name value. |
string |
None. |
| PaymentMethod |
The payment method value. |
string |
None. |
| BankAccountType |
The bank account type classification. |
BankAccountType |
None. |
| AccountType |
The account type classification. |
AccountType |
None. |
| CrIsPositive |
Indicates whether cr is positive is true. |
boolean |
None. |
| SystemType |
The system type classification. |
SystemType |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{
"AccountName": "sample string 1",
"AccountNumber": "sample string 2",
"Sortcode": "sample string 3",
"OpeningBalance": 4.0,
"IBAN": "sample string 5",
"BIC": "sample string 6",
"CountryCode": "sample string 7",
"BankName": "sample string 8",
"PaymentMethod": "sample string 9",
"BankAccountType": 0,
"AccountType": 0,
"CrIsPositive": true,
"SystemType": 0,
"Id": 10
}
Response Information
Resource Description
The response returned after the operation completes.
BankAccountDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| BankAccountType |
The bank account type value. |
string |
None. |
| AccountNumber |
The account number value. |
string |
None. |
| SortCode |
The sort code value. |
string |
None. |
| IBAN |
The iban value. |
string |
None. |
| BIC |
The bic value. |
string |
None. |
| BankName |
The bank name value. |
string |
None. |
| IsPrimary |
Indicates whether this item is primary. |
boolean |
None. |
| AccountStatus |
The account status classification. |
AccountStatus |
None. |
| Name |
The name value. |
string |
None. |
| AccountType |
The account type value. |
string |
None. |
| TotalBalance |
The total balance value. |
decimal number |
None. |
| TotalUnclearedBalance |
The total uncleared balance value. |
decimal number |
None. |
| TotalAvailableBalance |
The total available balance value. |
decimal number |
None. |
| AccountPosition |
The account position value. |
decimal number |
None. |
| DepositHeldBalance |
The deposit held balance value. |
decimal number |
None. |
| Status |
The status value. |
string |
None. |
| ChildAccounts |
The collection of child accounts. |
Collection of integer |
None. |
| AccountGroupId |
The unique identifier of the related account group resource. |
integer |
None. |
| Fees |
The collection of fees. |
Collection of AgencyFeeDataContract |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"BankAccountType": "sample string 1",
"AccountNumber": "sample string 2",
"SortCode": "sample string 3",
"IBAN": "sample string 4",
"BIC": "sample string 5",
"BankName": "sample string 6",
"IsPrimary": true,
"AccountStatus": 0,
"Name": "sample string 8",
"AccountType": "sample string 9",
"TotalBalance": 10.0,
"TotalUnclearedBalance": 11.0,
"TotalAvailableBalance": 12.0,
"AccountPosition": 13.0,
"DepositHeldBalance": 14.0,
"Status": "sample string 15",
"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": "2026-08-12T12:37:01.2681761Z",
"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": "2026-08-12T12:37:01.2681761Z",
"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": "2026-08-12T12:37:01.2681761Z",
"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": "2026-08-12T12:37:01.2681761Z",
"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": "2026-08-12T12:37:01.2681761Z",
"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": "2026-08-12T12:37:01.2681761Z",
"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": "2026-08-12T12:37:01.2681761Z",
"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": "2026-08-12T12:37:01.2681761Z",
"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": "2026-08-12T12:37:01.2681761Z",
"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": "2026-08-12T12:37:01.2681761Z",
"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": 16
}