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": "c53dec69-37db-4a4d-b9f1-ee0c05a41148",
  "_parent_id": "d64a60ec-568a-480f-b783-38670daca6df",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "14bc3f70-a7d3-4f93-92c2-0c868524ce69",
  "company_id": "2f16a907-205f-495a-8213-fbd543de314a",
  "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": "0769b3bf-a511-4b7f-90c7-6a657e419c5c",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "69857294-6b1e-4401-a37e-aae79557d209",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "12999476-2718-413e-98c6-3cad993a4e84",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "4646c9cd-6b73-4191-9eed-639596d31476",
    "company_code": "sample string 5",
    "company": {
      "id": "b97e91a3-5f78-41d0-a5d5-4b3bcc62cd2b",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2026-05-29T13:58:28.1348709+00:00",
      "sales_territory_id": "83b67783-39cb-464f-b6ed-de4e0116dbfb",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "2c0a2dd4-8dc3-4b3a-97fe-fee71bb5da0b",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "d1701e80-33c3-47a7-9d8a-6a4331b8f23b",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "ba75821a-dff5-4703-9df5-5fecf482419e",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "7bb3a346-d90e-40fe-9461-5de333457dad",
          "db_currency_id": "f9f549b8-a86c-4828-86cb-e9b3e4c4919a",
          "db_language_id": "29dd4433-a5b1-41fb-b20a-8e9c64cf71ff",
          "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-29T13:58:28.1348709+00:00"
        },
        "modified_dateutc": "2026-05-29T13:58:28.1348709+00:00"
      },
      "marketing_segment_id": "df7ca03b-6c75-4fd6-be25-f2b0e016b86a",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "dd235afa-3df4-42fe-9656-a8a58ffb8f79",
      "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": "e9b5746d-c55d-41d1-b960-1e297bb4af27",
      "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": "4b75767f-a6a8-4f83-b0a5-7a0229a97fc1",
      "db_country_code": "sample string 28",
      "feelist_id": "2fa885d4-32c7-41b1-a754-31935fef7a91",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "6a43e52c-7606-4b5f-b2b7-a7f7e05f48e6",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "b8484091-63ee-4ba5-bd4a-78308f312764",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2026-05-29T13:58:28.1348709+00:00",
        "db_currency_id": "e5fdcf85-983e-4cba-ad65-71df64fefe85",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "42ecf936-59cf-4481-81e1-d3c5e9046e9f",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "aa388ff7-76f4-41bc-a973-88b05c528b21",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "fb21ba5d-5bf8-4880-94d4-73387b72b730",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "09651dc9-88b3-4386-a3a6-643a8f8c4213",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "232e004c-d0ce-4385-ba97-8a3026708835",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "1684ef5f-7e62-4f0d-a130-a614d187d48e",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "a8cd5cc1-9f0c-45ae-8df6-fb66b6a5994f",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2026-05-29T13:58:28.1348709+00:00"
      },
      "company_sector_id": "089d2b49-55e4-45e5-a16f-3c09e9511572",
      "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": "dffb4713-b590-4f66-98d5-ee08d56e14c7",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "957401f1-e625-472b-bfeb-277ca3f5f163",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "8c2b8c22-0c11-46bd-9db4-3cafe95e780b",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "2eac45cc-dc4b-45f4-8751-477c4abf214a",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2026-05-29T13:58:28.1348709+00:00",
      "id2": 60
    },
    "db_language_id": "09f3c823-ee4a-4940-933f-a24837632753",
    "db_language_code": "sample string 7",
    "db_title_id": "9dc4ff82-ccaf-47c8-b42d-35b68936cd23",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2026-05-29T13:58:28.1348709+00:00",
    "create_date": "2026-05-29T13:58:28.1348709+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-29T13:58:28.1348709+00:00"
  },
  "modified_dateutc": "2026-05-29T13:58:28.1348709+00:00",
  "id2": 22
}