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": "15585845-8f27-4e81-9528-8ca19d113c9d",
  "_parent_id": "31b5a56f-14bd-4d5c-8141-f67f1433eac6",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "3a836ee7-ac67-47e5-95dd-d3eb400db6ed",
  "company_id": "8896a8b4-c0d1-4849-b254-0d695716a7cd",
  "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": "145efa00-9117-489d-b02b-d4706ce9efd3",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "5402cfb5-8702-45fb-8c63-78747678bc62",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "fd5dc477-0569-4111-a2a4-c9bd98405e01",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "5dd5d77f-9b2f-43f7-ac1b-24e0a8a6e0c4",
    "company_code": "sample string 5",
    "company": {
      "id": "c4e6027f-be5c-4bbe-9eae-c3b2258357fc",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2025-10-14T12:44:48.3261497+00:00",
      "sales_territory_id": "f71d5dd4-48e7-4003-864f-38cf1c26ba80",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "939b4357-6273-47bb-9c4d-d5a4bcd6206f",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "c3c1e145-8a1d-4403-aa04-8408aa4c6eaf",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "865d189b-576f-470e-8d5f-083bf59a8396",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "2eb3de8d-1ac0-4dce-bcb8-d789d9ba5dec",
          "db_currency_id": "4fc582cf-b224-43da-9f7c-bf3193f137c5",
          "db_language_id": "48f09fed-e124-4614-9a1d-788cd0d98468",
          "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-14T12:44:48.3261497+00:00"
        },
        "modified_dateutc": "2025-10-14T12:44:48.3261497+00:00"
      },
      "marketing_segment_id": "d3651995-17fd-4f0d-8706-87fde164190c",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "6e3ecdb3-3787-4e87-ba4b-1ebc16ce0947",
      "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": "9df05891-d711-4415-b930-11e4ca4f7253",
      "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": "28070fd7-0d88-47dc-951d-22a82d91311d",
      "db_country_code": "sample string 28",
      "feelist_id": "642afbb1-6aff-4402-94de-ecaa26f0c2ae",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "ef4d4c98-2d8e-4107-861b-f80058ead40a",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "9de391f6-856d-4082-96f8-724329e2bca9",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2025-10-14T12:44:48.3261497+00:00",
        "db_currency_id": "b4d56846-b896-4a0d-b7d9-b5fb877e4e9e",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "1d05dee4-988f-4469-8733-b398956aefb5",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "d7e0f96f-5e36-42fd-96b4-db99b0637e8a",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "a7c1ef11-98fc-45cc-be84-a60e587d7b8b",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "bfb16f99-a986-441d-a133-09371903ed4a",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "435bfdc5-a90e-4e9c-a820-e35672ee777f",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "2471c1bd-74d8-4c14-9fa5-617bf3bbbc95",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "0fd5c32e-9fc2-481a-8cfb-917b7f3ace7d",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2025-10-14T12:44:48.3261497+00:00"
      },
      "company_sector_id": "499e4f4a-8f78-4885-aaad-5799a763e7fd",
      "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": "8ab45580-3a76-412d-beed-52de461e2cbd",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "42983d2f-d3c8-446d-b604-c8d979ba428e",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "fbbe826c-1c13-4e30-b304-18fbb9f453f7",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "5f07f644-b880-4712-8943-54ce9d13a841",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2025-10-14T12:44:48.3261497+00:00",
      "id2": 60
    },
    "db_language_id": "5cdaac69-d88f-4535-8ab9-0e25de5207f3",
    "db_language_code": "sample string 7",
    "db_title_id": "dcf3ccc3-65e6-47e3-99bf-a7ff862ce015",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2025-10-14T12:44:48.3261497+00:00",
    "create_date": "2025-10-14T12:44:48.3261497+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": "2025-10-14T12:44:48.3261497+00:00"
  },
  "modified_dateutc": "2025-10-14T12:44:48.3261497+00:00",
  "id2": 22
}