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": "166a70fb-b288-412d-9565-fcac5ee46a5a",
  "_parent_id": "845837ee-afaa-40d0-a2e6-99594827f61e",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "efab8cb7-4846-4a3b-a8c2-24668323ddda",
  "company_id": "ab0b2f8d-8dcb-40fb-b9bd-b9ca2a637cd3",
  "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": "526d08af-3ec5-4862-a58c-1d5d5c715bdd",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "2e18a958-314a-4eb3-b4b6-30302dfe491a",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "ea10daa2-099e-479c-ad2f-fd180c38ec32",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "c891da82-b7f9-4d49-b813-9aa31590959b",
    "company_code": "sample string 5",
    "company": {
      "id": "17f3270f-ab80-4f88-b04b-5420f1e17d0f",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2026-07-08T05:22:27.2080419+00:00",
      "sales_territory_id": "6bda0771-63eb-48a0-9904-27fc1e05ddf8",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "dcc3a7d1-675a-4776-a0a7-a95803d9730c",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "af352e23-44e8-44a0-8ffe-3fc124ef11ed",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "614a451d-2ce9-4ddc-a608-bec7872373de",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "bc52eace-6e5b-45e1-b6b7-1e3c323b8f73",
          "db_currency_id": "5c5bbc20-695b-457d-8d6d-bb0ba4ea8ff1",
          "db_language_id": "1dfeda2d-c9be-452b-b825-8349621332bd",
          "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-07-08T05:22:27.2080419+00:00"
        },
        "modified_dateutc": "2026-07-08T05:22:27.2080419+00:00"
      },
      "marketing_segment_id": "4f2a28a7-9a66-4eee-b40c-6b8d6cdc7051",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "359eb5f6-d63b-46ec-8416-043bafa62ac9",
      "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": "b76eec8c-f996-41fa-ac11-292d3bb4d273",
      "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": "6f4ac874-22bc-41e6-8d72-9285b001ce9d",
      "db_country_code": "sample string 28",
      "feelist_id": "ea0ef117-4417-48a8-9498-1133e051a4bb",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "f900ee7d-3622-40bc-9cec-3c4bd0221242",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "97e22cd3-a3bb-482d-ac94-0e3c08fd0dbf",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2026-07-08T05:22:27.2080419+00:00",
        "db_currency_id": "e7d3c158-7f93-4323-9b08-c0f6ee1df8aa",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "d22a4794-64bd-4e89-b222-6711b06d0971",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "c358053d-7f4c-4f49-95ca-321a1a2df415",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "289b1625-1375-4629-9974-fa1454c3af1c",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "d921a0cf-32cf-4e12-a0a9-a00b14687bd4",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "a51e8e19-3843-4fc5-b9f9-d930f7b6c531",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "8742ad7e-a514-44d0-b0c3-7d98b43369e5",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "2ae871b4-7821-42a6-a62b-75140a97c669",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2026-07-08T05:22:27.2080419+00:00"
      },
      "company_sector_id": "f3de8de5-dbfc-40fb-a358-5dcfe59232da",
      "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": "fcfbe6f9-038e-45d5-880f-4fde6308e655",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "de81e51f-5d48-4411-a5c2-a16c08e0280d",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "068e92ed-2082-45fe-9172-86320b206e7e",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "50962dd5-e22d-46a5-bad0-af8a3945171f",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2026-07-08T05:22:27.2080419+00:00",
      "id2": 60
    },
    "db_language_id": "569a6f54-d64f-470d-bd1c-d4dccc377160",
    "db_language_code": "sample string 7",
    "db_title_id": "b4172a7f-11f4-494f-aa72-a7c6b33a5259",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2026-07-08T05:22:27.2080419+00:00",
    "create_date": "2026-07-08T05:22:27.2080419+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-07-08T05:22:27.2080419+00:00"
  },
  "modified_dateutc": "2026-07-08T05:22:27.2080419+00:00",
  "id2": 22
}