Retrieves the equipment_family object with the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

equipment_family
NameDescriptionTypeAdditional information
id

Primary Key

globally unique identifier

Required

name

Name of the equipment family

string

Required

Max length: 50

description

Description of the equipment family

string

Max length: 4000

code

The Id/Ref of the back office. Used by Embedded entity

string

Max length: 50

_parent_id

Parent Equipment Family (Parent / Child) when adding/updating equipment_family

globally unique identifier
_parent_code

Embedded entity "equipment_family" for parent (Parent / Child) using ERP PK when adding/updating equipment_family

string
_parent_equipment_family

Embedded entity "equipment_family" for parent (Parent / Child) when adding/updating equipment_family

equipment_family
sales_organization_id

FK of sales_organization. Filled if specific of one SO, empty if can be used by all

globally unique identifier
sales_organization_code

Embedded entity "sales_organization" using ERP PK when adding/updating company_type

string
sales_organization

Embedded entity "sales_organization" when adding/updating company_type

sales_organization
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

date

Response Formats

application/json, text/json

Sample:
{
  "id": "33f7703b-75c7-4235-8cd3-f9f6b3d1ae2d",
  "name": "sample string 2",
  "description": "sample string 3",
  "code": "sample string 4",
  "_parent_id": "bc1ef537-8c27-4cd1-9a4e-a2cb47412602",
  "_parent_code": "sample string 6",
  "sales_organization_id": "15b068f0-d6f6-4b39-ab83-a9e29a5b925e",
  "sales_organization_code": "sample string 8",
  "sales_organization": {
    "id": "888ab0df-d41d-4fd1-a1db-7337bd8ee439",
    "code": "sample string 2",
    "name": "sample string 3",
    "description": "sample string 4",
    "db_country_id": "a915e9eb-da8b-413f-8474-b5e6ad74cb8f",
    "db_currency_id": "7b5d11f1-7f7a-4bff-9006-485b7985af28",
    "db_language_id": "691c8cf0-90fa-4b45-a835-e8f1e3f18aa5",
    "accountancy_code": "sample string 8",
    "archived": true,
    "default_unit_of_measure_system_type": "sample string 10",
    "street": "sample string 11",
    "street2": "sample string 12",
    "street_number": "sample string 13",
    "zip": "sample string 14",
    "city": "sample string 15",
    "email": "sample string 16",
    "phone": "sample string 17",
    "fax": "sample string 18",
    "url": "sample string 19",
    "vat_reg_code": "sample string 20",
    "modified_dateutc": "2025-10-06T05:00:50.2663531+00:00"
  },
  "modified_dateutc": "2025-10-06T05:00:50.2663531+00:00"
}