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": "0b918ead-0741-4aa0-af7b-010c6f711fa6",
  "_parent_id": "1f031291-14c9-4ad0-b1cc-2894c4980380",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "94347df2-4409-4f23-bd6f-112d20f59c61",
  "company_id": "7e87e938-683e-4c4e-b352-a53255122d53",
  "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": "3a2295b5-c245-4730-84da-f33498bcb0b8",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "22dedbde-1763-46a3-a0da-ee69e2ce7d3b",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "473a0ee8-900a-49c7-811f-dbec82260971",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "34d4786a-ed76-4b43-aae0-e3e5cb00dded",
    "company_code": "sample string 5",
    "company": {
      "id": "e940c3dc-a59c-4e7d-9bd9-7b25d7c7f5ba",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2026-09-22T10:45:29.2858518+00:00",
      "sales_territory_id": "d5477a85-1a53-47bb-954c-1c0bb19b55aa",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "ee42451a-d877-41be-a7b1-8ed5c746d7f4",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "943b4761-6b34-4306-bb7e-9447ffd27e2d",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "771a8525-04fb-42e1-bc5b-1b925b3660ea",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "ce750846-18bc-47b2-8d31-8d19fb20a3ba",
          "db_currency_id": "9aeb2dd3-f3c4-45aa-af1e-aff1949d4f19",
          "db_language_id": "114fa51c-f077-4100-837f-d2de3df63a77",
          "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-09-22T10:45:29.2858518+00:00"
        },
        "modified_dateutc": "2026-09-22T10:45:29.2858518+00:00"
      },
      "marketing_segment_id": "9a1956e0-b35b-4cd4-8c5e-ee78dc5a3554",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "a1d71206-d18a-4fe2-96db-1d9b46e98efa",
      "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": "bbb37fc6-de0b-4425-a7d0-781c06cf0fef",
      "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": "b936f3b4-808b-41a5-a956-3263a315bfe6",
      "db_country_code": "sample string 28",
      "feelist_id": "09ac2340-bb2d-4212-88d4-ebb38fc4377c",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "8d5cbbc8-7e31-405e-ba4f-c5b997e71e9d",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "ebd75e26-6926-4234-8183-23786e0b1ec9",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2026-09-22T10:45:29.2858518+00:00",
        "db_currency_id": "ef98ea98-0dd0-4545-8e2a-93e393d21fff",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "dc06d6b0-622a-48da-b36a-7b2f20ea04ef",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "d06c66a5-825f-4d7e-98f2-ff258f3c0b9c",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "948765bf-4a94-497d-98a8-5c6830860268",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "43d519c8-f53b-4f5d-a578-3b76fefc16e0",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "1b949e75-c890-4c77-a0ab-4e4cfead6739",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "4354eb8a-39a5-4f2d-8fab-306d120b97a6",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "7410804f-3b9b-41c8-91c4-d34fd7dafcb0",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2026-09-22T10:45:29.2858518+00:00"
      },
      "company_sector_id": "8ae0caf2-4b5c-4b99-a332-ba6cafa354b8",
      "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": "9297e883-5501-4485-a807-be5b6fe7fe2f",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "9dcc2804-5e94-4f3e-b1b1-eee21f2f3591",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "f2f7f627-4dee-4617-9755-2df15ee9f336",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "7a9b3657-b237-49cc-8717-7df2f071d62d",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2026-09-22T10:45:29.2858518+00:00",
      "id2": 60
    },
    "db_language_id": "8c9d245d-535a-4171-841d-b556b1eb98c0",
    "db_language_code": "sample string 7",
    "db_title_id": "c4c0b465-3243-4b52-b0cc-832985881baa",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2026-09-22T10:45:29.2858518+00:00",
    "create_date": "2026-09-22T10:45:29.2858518+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-09-22T10:45:29.2858518+00:00"
  },
  "modified_dateutc": "2026-09-22T10:45:29.2858518+00:00",
  "id2": 22
}