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": "2468bcd6-b0db-4f86-8daf-eb658afa08b4",
  "_parent_id": "1ebba593-7957-465d-a21d-afd154817412",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "af3b3ba7-0eb8-49c2-be25-428b19bd1e12",
  "company_id": "fa4a79fa-dcc6-4c6f-8dc2-65f093da207a",
  "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": "adb443a3-3ae6-4a10-a5c5-372f32d0ddfe",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "f609eb20-397d-4867-a027-11a60c4ea386",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "47e69a84-4bae-47d2-b30d-fb2213538435",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "3b8c160f-fbb0-4198-a674-de484fb225a0",
    "company_code": "sample string 5",
    "company": {
      "id": "84e2002d-fb43-49e5-a821-5fc61e5e5e1e",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2022-08-17T03:34:19.6078922+02:00",
      "sales_territory_id": "40c84d4d-a4f0-4dda-8e1d-edc6d998b463",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "760108c6-84f4-4a6f-b7d7-924141884128",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "217162d2-935a-470c-a4d5-39469901d311",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "16d22cd7-1df1-483a-a3ad-3b5e4773629d",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "b61e707b-8b0f-4e76-86ce-7d4d09fbbcec",
          "db_currency_id": "6bf8bdd7-bd54-428f-a547-8718b77d11db",
          "db_language_id": "3cb13862-961f-4b78-87b1-366312866247",
          "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": "2022-08-17T03:34:19.6078922+02:00"
        },
        "modified_dateutc": "2022-08-17T03:34:19.6078922+02:00"
      },
      "marketing_segment_id": "5d7c1f2e-90a1-43de-9c30-7c78deb38184",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "2fe99802-3730-4b4b-8905-6a5f2ff9dc38",
      "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": "b7df1227-854a-45b9-a79e-58fc7f2c8698",
      "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": "2a594771-b087-4e41-9da1-11f150bfbc19",
      "db_country_code": "sample string 28",
      "feelist_id": "4647180f-9a90-4c92-a953-c524b624cbdb",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "8f9508e7-af71-4fd4-a490-92e5ece0379c",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "ba95124e-17a5-4edf-ad34-37e4c47fc766",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2022-08-17T03:34:19.6078922+02:00"
      },
      "company_type_id": "448ec6f1-951e-438b-96f7-9a1db66ce910",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "19314f20-c001-40d6-a0a8-348d7a93587f",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "db46dd93-7b7d-407c-874c-ed47537eaca7",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "5480c859-3bc4-4658-807e-4d136da6713e",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "1ce39fde-3edc-45cc-b1eb-ef2f9379497a",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "a8fa6eab-a825-4bc9-853b-e71c81a70c79",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "35e9c80e-76cd-4356-9c2f-2a4682b99142",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2022-08-17T03:34:19.6078922+02:00"
      },
      "company_sector_id": "4a263929-0d4b-46d7-bc14-03d727b8296d",
      "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": "1ee3c729-f37a-4bfc-bcc0-e2a7cb6aa59d",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "ecf9e52f-d049-4003-b497-ea0789ba51c2",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "dd9f80b3-2643-4ee7-a7cd-2ea2e460b818",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "7f336401-8845-4d02-8dd6-98e88905bade",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2022-08-17T03:34:19.6078922+02:00",
      "id2": 60
    },
    "db_language_id": "5d7bc0c3-df38-4f89-8381-c54f789bf052",
    "db_language_code": "sample string 7",
    "db_title_id": "3fee3c4d-ff97-4cf1-acf6-381e74ff1311",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2022-08-17T03:34:19.6078922+02:00",
    "create_date": "2022-08-17T03:34:19.6078922+02: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": "2022-08-17T03:34:19.6078922+02:00"
  },
  "modified_dateutc": "2022-08-17T03:34:19.6078922+02:00",
  "id2": 22
}