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": "a163fa27-19ef-4693-a65d-4509075fb7aa",
  "_parent_id": "066ce12f-5188-4d46-a097-07353202731c",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "ae134f7f-63cf-4ad9-9670-a1142e847555",
  "company_id": "078ca872-ce9b-4e2a-bdec-38de2bce35f2",
  "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": "d68d8864-3575-4c75-accc-ee2208a9622d",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "4e324711-38e7-4bb9-85f8-690274ae6d03",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "c693e2dd-35b5-4edf-afbc-7182889cb1f0",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "8016df6b-99cb-4eba-b00b-5c629b13597c",
    "company_code": "sample string 5",
    "company": {
      "id": "dee58bb2-338f-4e3a-8fc8-1e44a2622e1f",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2026-08-14T07:29:04.2742299+00:00",
      "sales_territory_id": "c776f936-8ac6-44b0-b72e-e98fd126eff2",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "b82dd38e-bcdd-45d8-a77c-3aad49b5e101",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "a8e0c8ea-1a7b-4b1d-8c64-ea2cc5013ff4",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "39862ab5-4890-4bc6-89a3-b2520f80debc",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "bfcf7428-55db-4670-8672-ef71463301f9",
          "db_currency_id": "a7ac19d2-71c9-454f-82bd-576d21af82d6",
          "db_language_id": "371b06f2-cc83-43f3-9a03-34b315936be8",
          "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-08-14T07:29:04.2742299+00:00"
        },
        "modified_dateutc": "2026-08-14T07:29:04.2742299+00:00"
      },
      "marketing_segment_id": "9dc02125-6c89-451a-9cfe-a911887c3828",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "00398ad6-11bd-4cf0-8587-6f1cc43a4e9b",
      "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": "b8d37277-1d93-41f6-aa30-529778b69954",
      "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": "768bf2a5-f47d-4de5-82d6-63f4a55df1ca",
      "db_country_code": "sample string 28",
      "feelist_id": "c17fe7b1-fbe2-4340-8691-b03acd044c0d",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "fdeeeb77-b953-4b1d-bdb2-fb49b82e92ef",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "dc533bac-b381-41e2-8405-9e6e1c40a8ac",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2026-08-14T07:29:04.2742299+00:00",
        "db_currency_id": "61f9f3e2-bc2b-44c0-b1a6-62a26d533919",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "05821a62-13b6-4c8d-8c52-c51d6321e53d",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "b9c6bbae-0cbf-4972-a7a7-221deb3eb52e",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "6474a16e-fb8e-44e9-935b-e82dded036c9",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "7c74d6a7-7a5c-4c7f-91e4-f0aa1c39aa80",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "a8333b2d-6b5f-403d-89ee-098285647461",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "c4dc79de-5a82-4ab2-8aac-95b54a803bc7",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "13a8cc54-0d24-4f84-80b2-d0553ae9a5cd",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2026-08-14T07:29:04.2742299+00:00"
      },
      "company_sector_id": "92204880-8d4a-4857-aada-bbaa375f80ff",
      "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": "db56f52c-f9db-44b7-99f1-b5ea407b699c",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "f39dc3d8-9921-4e68-b8cd-19612999f780",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "eb1712aa-563b-4e27-909f-fc4e4ddcca61",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "6d5a69ed-59bb-4e97-878a-8fa6e5dbcce3",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2026-08-14T07:29:04.2742299+00:00",
      "id2": 60
    },
    "db_language_id": "ab0b884f-e146-4092-af91-b741afd3bc68",
    "db_language_code": "sample string 7",
    "db_title_id": "d85b9083-b43d-4b4f-8b98-2e782dad3dfe",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2026-08-14T07:29:04.2742299+00:00",
    "create_date": "2026-08-14T07:29:04.2742299+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-08-14T07:29:04.2742299+00:00"
  },
  "modified_dateutc": "2026-08-14T07:29:04.2742299+00:00",
  "id2": 22
}