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": "d381314b-70b6-4e05-a511-21399b9bb037",
  "_parent_id": "da3e4609-df83-4a86-8a49-cb7605ec4807",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "04aceda8-d639-4c9c-ac30-6a2b1766d12d",
  "company_id": "0d2afe46-b45f-4f89-b8d1-64bd97e0136d",
  "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": "cbf516c7-53d1-454d-9c46-76559840f6b0",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "eed17c1c-e368-444f-9ec7-a3c0cce4c0c7",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "23340100-f360-409b-8055-977e28a150e9",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "bdf01336-9df4-4ee0-8e08-260246a28420",
    "company_code": "sample string 5",
    "company": {
      "id": "553ad6d8-cfc7-4d56-a5e6-809bff4e50d3",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2025-10-16T04:47:24.2134636+00:00",
      "sales_territory_id": "d9a60b84-02ac-4391-85e9-abb62b2fd348",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "bdb7aaa1-93cb-4941-aef6-4ff1e3755241",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "f169d4b5-6772-4e46-a2b6-875a8701b2b2",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "ebb4205a-4115-4041-81b9-d9027d6278ec",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "e2e9b3a8-0fa7-47f6-b194-51e9410b1ea7",
          "db_currency_id": "62adeb81-5c12-43fd-ba8f-a858cc3a7987",
          "db_language_id": "8ee708f0-8965-4fef-b516-98dac08ae9d5",
          "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-16T04:47:24.2134636+00:00"
        },
        "modified_dateutc": "2025-10-16T04:47:24.2134636+00:00"
      },
      "marketing_segment_id": "28948852-dc5d-4d7c-a9ba-498522b9df27",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "7b77650e-9407-47d2-ab5e-c7f92cec55f0",
      "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": "c0df5fb9-0d5b-461b-9e34-1c0696703eac",
      "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": "b35baea2-2838-42e7-8747-573e8a06caf4",
      "db_country_code": "sample string 28",
      "feelist_id": "ee992dc2-0320-44e4-ab33-4f48ef8d9ae6",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "cb227fde-86af-4931-aa30-3f8af51c0819",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "ea36f7e2-3936-48eb-b45f-4c68adab117f",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2025-10-16T04:47:24.2134636+00:00",
        "db_currency_id": "43dc5aa6-75b5-4ce9-b016-de3fcc86e17b",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "d0415a6e-9cb9-4239-af16-53062f6a98d8",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "4c08572d-a138-4a3a-810f-3c3071e007ec",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "3eb5e6b0-7196-421e-b3cf-aa82724efc7e",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "c99d35ed-c297-4dc2-8db0-f23b71ac9845",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "fea2b878-f657-4840-b3e9-da0a05f60ea9",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "94bfc9f1-b729-4820-962b-30fe16cc0728",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "4c378a0b-c136-43a9-970a-070ec59e68a5",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2025-10-16T04:47:24.2134636+00:00"
      },
      "company_sector_id": "9f2370d9-9ed9-42af-960d-23aa0199e45c",
      "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": "cc4536ed-ca46-40b2-8c92-99dd578531fc",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "8e4f4dff-eb0f-4fbd-87ce-ab90b6c3e7b8",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "be2eef4b-0216-490b-9023-0f58d99ba09b",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "8af2b081-06d0-47d4-82f4-98ee97b3c44d",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2025-10-16T04:47:24.2134636+00:00",
      "id2": 60
    },
    "db_language_id": "66006fc4-87e5-4829-8123-49a72f69e277",
    "db_language_code": "sample string 7",
    "db_title_id": "1db9f43c-b321-4b59-8aba-7fee8ddcece3",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2025-10-16T04:47:24.2134636+00:00",
    "create_date": "2025-10-16T04:47:24.2134636+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-16T04:47:24.2134636+00:00"
  },
  "modified_dateutc": "2025-10-16T04:47:24.2134636+00:00",
  "id2": 22
}