GET api/account/systemaccount
Get System Account for the Accounting System Processes this account API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
The response returned after the operation completes.
AccountDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| 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:
{
"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": "2026-07-23T08:18:45.1181356Z",
"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-07-23T08:18:45.1181356Z",
"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-07-23T08:18:45.1181356Z",
"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-07-23T08:18:45.1181356Z",
"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-07-23T08:18:45.1181356Z",
"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-07-23T08:18:45.1181356Z",
"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-07-23T08:18:45.1181356Z",
"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-07-23T08:18:45.1181356Z",
"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-07-23T08:18:45.1181356Z",
"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-07-23T08:18:45.1181356Z",
"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
}