GET Account/GetAccountsByCategoryId/{id}

Gets a list of Accounts based on the Category identifier.

Request Information

This method supports OData queries.

URI Parameters

NameTypeAdditional informationDescription
id integer

Required

Body Parameters

None.

Response Information

Resource Description

This collection is wrapped in a paging response object.

Paging response of Account
NameTypeAdditional informationDescription
TotalResults integer

None.

ReturnedResults integer

None.

Results Collection of Account

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalResults": 1,
  "ReturnedResults": 2,
  "Results": [
    {
      "Name": "sample string 2",
      "Category": {
        "Comment": "sample string 1",
        "Order": 6,
        "Description": "sample string 7",
        "ID": 8,
        "Modified": "2024-11-15",
        "Created": "2024-11-15"
      },
      "Active": true,
      "Balance": 4.0,
      "Description": "sample string 5",
      "ReportingGroupId": 1,
      "UnallocatedAccount": true,
      "IsTaxLocked": true,
      "Modified": "2024-11-15",
      "Created": "2024-11-15",
      "AccountType": 9,
      "HasActivity": true,
      "DefaultTaxTypeId": 1,
      "DefaultTaxType": {
        "ID": 1,
        "Name": "sample string 2",
        "Percentage": 3.1,
        "IsDefault": true,
        "HasActivity": true,
        "IsManualTax": true,
        "Active": true,
        "Created": "2024-11-15",
        "Modified": "2024-11-15",
        "TaxTypeDefaultUID": "362c9c06-d987-45fa-af7c-099c3e89284f",
        "CompanyId": 9
      },
      "ID": 11
    },
    {
      "Name": "sample string 2",
      "Category": {
        "Comment": "sample string 1",
        "Order": 6,
        "Description": "sample string 7",
        "ID": 8,
        "Modified": "2024-11-15",
        "Created": "2024-11-15"
      },
      "Active": true,
      "Balance": 4.0,
      "Description": "sample string 5",
      "ReportingGroupId": 1,
      "UnallocatedAccount": true,
      "IsTaxLocked": true,
      "Modified": "2024-11-15",
      "Created": "2024-11-15",
      "AccountType": 9,
      "HasActivity": true,
      "DefaultTaxTypeId": 1,
      "DefaultTaxType": {
        "ID": 1,
        "Name": "sample string 2",
        "Percentage": 3.1,
        "IsDefault": true,
        "HasActivity": true,
        "IsManualTax": true,
        "Active": true,
        "Created": "2024-11-15",
        "Modified": "2024-11-15",
        "TaxTypeDefaultUID": "362c9c06-d987-45fa-af7c-099c3e89284f",
        "CompanyId": 9
      },
      "ID": 11
    }
  ]
}