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": "881bd707-3f03-4f1f-b72d-b52280a472e6",
  "_parent_id": "9838a5f4-c692-400e-a6a7-c943da9d1d9c",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "c958d2f3-1121-487e-9016-b5c07c1cd95c",
  "company_id": "421e8103-766d-4f9a-91de-df1d0a2f2c1a",
  "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": "d0d815ad-288e-4759-807f-2cf52f4c8c91",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "00f5692d-7576-4b9c-abd2-7cf03160b9e7",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "973cdb59-4e65-4a30-a873-fa1cf5afc780",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "47f5ea38-0f33-488d-bc3b-768e0b0e7516",
    "company_code": "sample string 5",
    "company": {
      "id": "fdc9af1a-ab58-4341-9e1f-512be273a87a",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2025-03-16T06:41:36.2511899+00:00",
      "sales_territory_id": "1a98e338-bf24-40d8-bcc1-3728d1e1b9f9",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "f2f7633d-6ef1-4cb5-a4c1-4d34dbfa2d7e",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "580da619-088e-4eb4-b5fd-bc2abff97448",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "35a78890-91b0-4071-b82b-addb90a45066",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "26807257-0f75-478b-8a26-bc8ff4af2d6c",
          "db_currency_id": "c0b1ace7-dedc-44be-ba7a-ca9c3bdbddc1",
          "db_language_id": "6599c7ba-3626-4407-91a5-541f039974ea",
          "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-03-16T06:41:36.2511899+00:00"
        },
        "modified_dateutc": "2025-03-16T06:41:36.2511899+00:00"
      },
      "marketing_segment_id": "668da82d-4ffb-438c-a4bb-5fc99c8def0b",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "7ed49f61-7479-4933-a909-554d3ef77f3f",
      "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": "46542c91-d4c3-4981-aeed-4721590c9f71",
      "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": "f83db721-31f3-48e2-a6ed-32c7d7b016c6",
      "db_country_code": "sample string 28",
      "feelist_id": "cae5397d-bcfe-4d8f-8a81-447cb6d51b94",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "d59368e1-8df7-4faf-9864-29b0e0cd1922",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "5fba7656-105b-44c4-b4f6-ff85d77a7c98",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2025-03-16T06:41:36.2511899+00:00",
        "db_currency_id": "513759a3-3629-4131-8955-2e0b1b785bd0",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "b3ab9432-8dd2-41b8-80f0-81161ce8e176",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "e9693fc7-2ff8-4ace-8421-7b33ff1eae22",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "552b0f55-9761-4814-9924-c0a2011742c9",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "6bff449e-3dce-4955-9e47-3fdb060170d3",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "320d38b0-770f-485e-aa15-fdf3fdcc5aa7",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "bc150d8d-f00e-4471-8657-4bef8f4af25b",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "7f9f033e-b311-455f-a1eb-d1ac2ed7a7c5",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2025-03-16T06:41:36.2511899+00:00"
      },
      "company_sector_id": "074d7208-b759-478f-8a2e-a180ffd36532",
      "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": "a2174a6d-36a1-452a-a66c-900576d16ac8",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "344fed67-e3f9-4a87-9156-9a30be706800",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "9cbde299-d350-44aa-bd88-c098930a215c",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "9dc0b86f-c7ac-4a62-95aa-baf8a4ac1224",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2025-03-16T06:41:36.2511899+00:00",
      "id2": 60
    },
    "db_language_id": "ab295342-b628-4188-a491-ed314f8cc952",
    "db_language_code": "sample string 7",
    "db_title_id": "e3df6981-4df8-4630-acf7-8cd2c342a069",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2025-03-16T06:41:36.2511899+00:00",
    "create_date": "2025-03-16T06:41:36.2511899+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-03-16T06:41:36.2511899+00:00"
  },
  "modified_dateutc": "2025-03-16T06:41:36.2511899+00:00",
  "id2": 22
}