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": "8b44b477-4650-4d2e-8758-d6ef07c39075",
  "_parent_id": "750e4a4a-8c76-4df0-94b5-7b5540202e0f",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "780cb8ce-3c1a-4167-a80e-a354472a3763",
  "company_id": "502b1606-36d8-4c40-ab4c-aaea8550106d",
  "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": "ef7d622c-1951-4f92-a569-6c2fbfe4adc1",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "032f0f39-bb41-4a06-9a30-ca18143f0188",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "9b3fa01b-9ad3-4b0b-917b-a3fd14506e32",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "ab2e7cdc-fe0e-4cfc-865e-55a53e9999f3",
    "company_code": "sample string 5",
    "company": {
      "id": "a434376f-fd2f-4e3b-85de-9fa5c374acfd",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2025-07-09T15:44:00.8483824+00:00",
      "sales_territory_id": "90ea20af-373e-4ec7-8319-1f3f04909af2",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "ccd26027-11ea-4102-b737-c4bd3f052584",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "6d4518d8-0a42-4a2c-af98-55bc432637da",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "d124c450-d704-4e8d-a7bb-c98c501864a2",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "c31ff241-9c8c-4013-94df-72462f89f578",
          "db_currency_id": "387772a0-4f8a-4a35-82bc-f938b66ba19f",
          "db_language_id": "1f70bcb4-2f3a-4158-9eae-753e790c8d02",
          "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-07-09T15:44:00.8483824+00:00"
        },
        "modified_dateutc": "2025-07-09T15:44:00.8483824+00:00"
      },
      "marketing_segment_id": "718ba2d3-8c8a-4d6f-bcd3-a7290eadd731",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "c0bf8dfd-55dc-4bab-898a-b37d8035a427",
      "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": "706354dc-edd4-43c8-a23d-bc57f1ffa744",
      "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": "207eb8c8-d975-4bf4-9fea-649e319fd51a",
      "db_country_code": "sample string 28",
      "feelist_id": "f44eca62-111a-4b4c-9d84-e793d7d1b43e",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "83b61655-c66c-4af6-94bd-58525700a5c2",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "ab959af0-2f59-4e92-8cb0-fad6d79926b9",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2025-07-09T15:44:00.8483824+00:00",
        "db_currency_id": "ae052881-32e6-4e26-b173-631657c5761a",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "c78fb878-3dce-4c35-9aad-dc34c20e8f1d",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "30088c5a-1b94-4f9d-980e-433b9fd8049f",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "7aa9953f-232e-471c-82c6-22f5dae28b1d",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "2e6e7161-e0d1-4b90-9e72-a9930014628c",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "a8323222-1782-4036-ab68-fd3ec64bf117",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "fe00be01-030c-440e-9718-9214631d7a56",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "b35ad4a7-2720-47a9-b3f7-779103c27f6a",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2025-07-09T15:44:00.8483824+00:00"
      },
      "company_sector_id": "f5911f99-cf8c-4062-a4bf-86fa45cab4be",
      "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": "dbb3770d-e421-4985-93f7-c04314e1f689",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "407f26a7-21f1-4bbb-a38a-a4dd687a04ec",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "c8f70332-774b-405f-b184-8e62ca0fb050",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "65f7235f-6d3f-4433-b7b9-fb704e09bda5",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2025-07-09T15:44:00.8483824+00:00",
      "id2": 60
    },
    "db_language_id": "cdcd83de-1524-4d94-a566-5eaeadd18270",
    "db_language_code": "sample string 7",
    "db_title_id": "5714b4f6-1677-474d-9423-7f790e7a9453",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2025-07-09T15:44:00.8483824+00:00",
    "create_date": "2025-07-09T15:44:00.8483824+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-07-09T15:44:00.8483824+00:00"
  },
  "modified_dateutc": "2025-07-09T15:44:00.8483824+00:00",
  "id2": 22
}