Retrieves an object of the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

location
NameDescriptionTypeAdditional information
id

globally unique identifier

Required

_parent_id

Reference to a parent location

globally unique identifier
_parent_reference_back_office

Embedded entity "location" for parent location using ERP PK when adding/updating location

string
_parent_location

Embedded entity "location" for parent location when adding/updating location

location
project_status_id

Foreign key to project_status_id

globally unique identifier
company_id

The company owner of this location

globally unique identifier

Optionally required : company_id, company_code or company must be provided

company_code

Embedded entity "company" using ERP PK when adding/updating location

string

Optionally required : company_id, company_code or company must be provided

company

Embedded entity "company" when adding/updating location

company

Optionally required : company_id, company_code or company must be provided

name

Name of the location

string

Required

Max length: 50

extra_information

extra_information

string

Max length: 255

reference_back_office

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

string

Max length: 255

street

Street

string

Max length: 100

street_number

Street number.

string

Max length: 50

zip

Zip code

string

Max length: 50

city

City

string

Max length: 50

phone

Phone number

string

Max length: 50

email

Email address

string

Max length: 250

db_country_id

Foreign key to table Country

globally unique identifier
db_country_code

CountryCode entity using international code when adding/updating company

string
street2

Additional information on the address not part of the postal address

string

Max length: 50

latitude_decimal

Decimal coordonate for the latitude. (-1;-1) means invalid and (0;0) means not already geo-encoded

decimal number
longitude_decimal

Decimal coordonate for the longitude. (-1;-1) means invalid and (0;0) means not already geo-encoded

decimal number
contact_id

Foreign key of contact for this location

globally unique identifier
contact_reference_back_office

Foreign key of contact for this location. If you don't know the GUID, use contact_reference_back_office

string
contact

Embedded entity "contact" when adding/updating location

contact
modified_dateutc

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

date
id2

Internal ID (numeric). Will be used if reference_back_office is empty

integer

Response Formats

application/json, text/json

Sample:
{
  "id": "44d79b94-641a-454f-be76-4032343171c1",
  "_parent_id": "76a58c75-763c-44c8-b14a-30579477190f",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "830796e5-193c-43e5-80f0-0b052dcda153",
  "company_id": "48beff42-3763-4c9b-9790-cccbae21303c",
  "company_code": "sample string 6",
  "name": "sample string 7",
  "extra_information": "sample string 8",
  "reference_back_office": "sample string 9",
  "street": "sample string 10",
  "street_number": "sample string 11",
  "zip": "sample string 12",
  "city": "sample string 13",
  "phone": "sample string 14",
  "email": "sample string 15",
  "db_country_id": "bf0e90f2-ae34-49f5-b28e-21f618ee806c",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "bb72046c-da1d-481c-91c2-842d93e94c17",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "15182b43-3539-4612-9522-a713071c74ed",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "c3cc65d5-df53-4de1-8a2d-bd0920edae55",
    "company_code": "sample string 5",
    "company": {
      "id": "9390ff5e-e62d-4715-ac84-41192ae92cf7",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2026-05-29T23:24:24.1226521+00:00",
      "sales_territory_id": "90759558-343a-4ea3-9093-6cb33849569d",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "83cede67-b778-45d0-a506-bed33fb5dc46",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "1a773860-a9db-4c2b-9089-ce637537fcc5",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "88667028-6a8b-4429-be9b-15f0d0d73191",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "85a67a8a-7a46-42d6-b4c7-0f982124d0f9",
          "db_currency_id": "080d961e-a3e4-4a3b-81a9-8fc48fc5e2fb",
          "db_language_id": "5d8241bc-68d9-471e-b022-488193ecde0f",
          "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": "2026-05-29T23:24:24.1226521+00:00"
        },
        "modified_dateutc": "2026-05-29T23:24:24.1226521+00:00"
      },
      "marketing_segment_id": "2b013457-d3e2-4394-9fe3-314bd4b70624",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "5590d7b9-3d29-4ca0-94e0-52f0ff4167d3",
      "sales_organization_code": "sample string 13",
      "company_sales_status_code": "sample string 14",
      "vat_reg_code": "sample string 15",
      "is_working_address": true,
      "parent_id": "6737389b-6de4-4b86-8480-8f33a8878203",
      "parent_company_code": "sample string 18",
      "phone": "sample string 19",
      "fax": "sample string 20",
      "url": "sample string 21",
      "email": "sample string 22",
      "street": "sample string 23",
      "street_number": "sample string 24",
      "city": "sample string 25",
      "zip": "sample string 26",
      "db_country_id": "270b1087-d94b-4644-b54d-bdb81f0a4344",
      "db_country_code": "sample string 28",
      "feelist_id": "5de184b0-942f-4e56-881e-23e3f3d09252",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "26f49676-0e3d-4b97-a920-4ba7a033154a",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "9d3a276c-76c5-4188-b367-207d32853c7f",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2026-05-29T23:24:24.1226521+00:00",
        "db_currency_id": "8d230d02-1573-4987-8482-a29b11328633",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "168c2d32-de7f-4372-a354-4c14b2f22d6b",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "25b5969d-65f9-4c87-9a32-85aae0c181a7",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "addece5c-1b75-4087-8aaf-e7f8e29a9b26",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "c1b39847-2dfd-4e3c-81ef-dfb1edc97820",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "e21c2796-1468-4829-8e69-886859b24da1",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "3c6607d8-33b1-4bba-9aa9-06002fa72b07",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "bd9f8451-e76e-45e4-b7c8-ab74ee68d1b9",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2026-05-29T23:24:24.1226521+00:00"
      },
      "company_sector_id": "020831d9-a078-4673-919d-bd91e1289760",
      "company_sector_code": "sample string 41",
      "is_lead": true,
      "is_subcontractor": true,
      "latitude": 1.0,
      "longitude": 1.0,
      "street2": "sample string 44",
      "bic_code": "sample string 45",
      "specialities": "sample string 46",
      "register_number": "sample string 47",
      "register_city": "sample string 48",
      "bankaccount": "sample string 49",
      "mobile": "sample string 50",
      "service_manager_user_id": "b38a964b-9d86-49cc-b75b-0ae022800fd2",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "970ce2c6-e584-4e79-8183-929509e9323a",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "0518254d-d6f0-4650-901b-f7e8f7c3fb1b",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "b8639be2-bec5-4fdc-81b5-97aab277ed94",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2026-05-29T23:24:24.1226521+00:00",
      "id2": 60
    },
    "db_language_id": "1b7d04fd-d529-45e0-bb5c-f635d5cb7dbc",
    "db_language_code": "sample string 7",
    "db_title_id": "d52d61f9-b83d-47a1-bd29-0b7c7f4f6118",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2026-05-29T23:24:24.1226521+00:00",
    "create_date": "2026-05-29T23:24:24.1226521+00:00",
    "phone": "sample string 16",
    "mobile": "sample string 17",
    "email": "sample string 18",
    "skype": "sample string 19",
    "private_phone": "sample string 20",
    "private_mobile": "sample string 21",
    "private_email": "sample string 22",
    "reference_back_office": "sample string 23",
    "modified_dateutc": "2026-05-29T23:24:24.1226521+00:00"
  },
  "modified_dateutc": "2026-05-29T23:24:24.1226521+00:00",
  "id2": 22
}