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": "6af04ac8-9c62-4052-84fc-fa2bd24d369c",
  "_parent_id": "7bf4db67-61b4-48af-98cc-e06f88eb1205",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "387c6549-bde1-442e-8a31-3b61ca703840",
  "company_id": "1cc597c8-0510-418c-96ce-3a6733c515bf",
  "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": "eab495c0-d882-43f3-9069-02b82880421f",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "8d3c59b6-a359-4f05-b0fa-4b773e754bca",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "5beab9bd-7197-49a8-9a44-ec216e0989ba",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "61e0541f-7714-4a9c-921c-55cf9de9718e",
    "company_code": "sample string 5",
    "company": {
      "id": "75578fe5-78a7-4ce9-a214-866edba1e6cd",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2025-05-16T16:52:10.3204128+00:00",
      "sales_territory_id": "16dc926d-0bbb-4686-a65e-aaed035f8acd",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "44cd5edf-3e12-4349-983c-6c76acde2b05",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "d2acd8b7-0cf0-45ac-871a-fce1f3fc399d",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "e136fddf-541b-4f92-b536-0e82758a4c00",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "a5a6c2b1-73c5-48d6-b1a9-ef272320328c",
          "db_currency_id": "fa67e51c-a7a1-4c0a-a558-b49157f6eaea",
          "db_language_id": "530d450f-0917-4a48-b7d9-310b50916e2c",
          "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-05-16T16:52:10.3204128+00:00"
        },
        "modified_dateutc": "2025-05-16T16:52:10.3204128+00:00"
      },
      "marketing_segment_id": "d0c1a743-b4b2-4b0f-ae86-c427de234b4b",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "ba7e5c88-005e-4d26-b1b7-b5b634c0d97b",
      "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": "c918a170-9078-4f0f-a7b9-183698442f47",
      "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": "679b433c-314a-4b17-8c6e-d45aa20afdf8",
      "db_country_code": "sample string 28",
      "feelist_id": "d60eb930-8246-4383-bb7a-05f86ac095e3",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "2ff0524b-d564-47c1-baef-1c1ae9b58d48",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "9ba3d983-d3e2-470c-bce0-39b35b307205",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2025-05-16T16:52:10.3204128+00:00",
        "db_currency_id": "0d622fd1-7298-4c9a-80e6-f89cbbc606c7",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "5d906bec-615b-4a4f-a12e-a3eb80188b42",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "331f234d-117c-4a26-af31-215ae6aa2713",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "3e198ecc-d8b9-457c-bea3-edc717165ec8",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "2cf1eab5-1827-4bee-a296-e2745e7a25a5",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "ead315f1-d4a8-4aee-b7e8-aeee9225ebba",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "e03ddbaa-64eb-4c69-80af-0fc30715e756",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "01c6b6e6-73b3-40e6-afcd-58c8b05a378a",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2025-05-16T16:52:10.3204128+00:00"
      },
      "company_sector_id": "e1a16137-e761-453a-9985-2846d98f0bbb",
      "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": "b8faef29-437a-4736-afe7-578bbf7fe97a",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "8f3f3c08-2c6b-4fe8-abd9-2d1e577c52d8",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "c8ff873f-7273-44a6-b9c8-c412df449786",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "26b08fb9-0acc-4adb-8f3b-7256fa1331d9",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2025-05-16T16:52:10.3204128+00:00",
      "id2": 60
    },
    "db_language_id": "49393c44-87a9-445b-995a-06dc274f0ade",
    "db_language_code": "sample string 7",
    "db_title_id": "4eb421cb-41f9-4a6a-a7ae-52c8072c5472",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2025-05-16T16:52:10.3204128+00:00",
    "create_date": "2025-05-16T16:52:10.3204128+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-05-16T16:52:10.3204128+00:00"
  },
  "modified_dateutc": "2025-05-16T16:52:10.3204128+00:00",
  "id2": 22
}