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": "856fd215-35c8-47ef-b43f-216c7b2a38a5",
  "_parent_id": "f0355bc6-a355-44df-97c0-3e67b6ae6b5c",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "7cc887f7-88c4-408d-a01e-2d77b181b1a7",
  "company_id": "ea86c9dc-41ba-48b5-9b39-176582173bd6",
  "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": "4a08e5d8-304c-45e8-8502-165f2d26eaa4",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "9433e36f-ea57-4229-be7e-94eccf04bcc0",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "fb00c75f-58f1-40de-b323-3b88082ddd2b",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "e6491c6b-c65e-4b35-ae14-956f974f23a9",
    "company_code": "sample string 5",
    "company": {
      "id": "82c850b9-f22f-4dac-9927-d8a693cce3ed",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2024-02-28T07:51:54.8455649+00:00",
      "sales_territory_id": "a559a8a2-d8d5-4a82-bece-3a803eb9f2e1",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "9461f6ec-7ce6-421f-9492-6d205c92ee75",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "f4dac406-eead-4845-9e26-ee9abbc86538",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "5e785eb3-8782-417b-b2d0-2c3228da5bf4",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "f0fafef8-a594-4797-81b6-8e9cf59264cd",
          "db_currency_id": "8468d2f4-56cd-46f9-9053-4683c7639bc4",
          "db_language_id": "3a85228e-19d6-4b3f-b16a-7cfbdedf0dbb",
          "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": "2024-02-28T07:51:54.8455649+00:00"
        },
        "modified_dateutc": "2024-02-28T07:51:54.8455649+00:00"
      },
      "marketing_segment_id": "bdb2c246-087d-4c6c-8047-015f81ead611",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "a4b8fd88-2743-439c-8369-08216c4b3309",
      "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": "0ae6af00-f459-4ab1-a5b0-003b74172a21",
      "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": "3071df36-4d41-4c33-96ef-e9483ea8af8b",
      "db_country_code": "sample string 28",
      "feelist_id": "09cccaf7-afa4-4ff6-96ae-cdfb2c954c90",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "06a72a8e-c89c-4f25-9503-fb1dd1109b65",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "4e41d424-e559-43ab-bf2e-aafd3c9bcc58",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2024-02-28T07:51:54.8455649+00:00",
        "db_currency_id": "ba1443ba-d1b8-4224-bfd4-6492adf66829",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "6ad3a156-efa8-4f1b-9701-87cf8d1c4ab9",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "91da456a-7d41-431c-b8dc-1a5fcbb99b92",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "a1a2b84d-59c3-4a53-a1e0-b9cd493f5cf6",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "d01eecf4-8158-426c-b861-a59c8f753a76",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "a7209105-9077-412a-9a18-30611e7a5449",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "8d3deee9-c6b5-4a32-bcdb-1ea0e950f2d4",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "640f30e0-ce36-4732-96cf-644df5368836",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2024-02-28T07:51:54.8455649+00:00"
      },
      "company_sector_id": "1694e6cd-f00c-4c8f-8dcd-82942f2c694f",
      "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": "7794d54d-6a50-4d3d-bbdf-6fd385348777",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "718d28ab-48e6-4972-afe0-73af0f8ba799",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "b182cb3b-6005-4ff8-b00b-fda96d0d6050",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "65f9e116-9ad1-4772-8602-9b7b769c7757",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2024-02-28T07:51:54.8455649+00:00",
      "id2": 60
    },
    "db_language_id": "ea7a9694-5d66-4ef7-ba73-c10a92a9756d",
    "db_language_code": "sample string 7",
    "db_title_id": "0aad4fd7-7e9d-4184-a4b2-e08e69050483",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2024-02-28T07:51:54.8455649+00:00",
    "create_date": "2024-02-28T07:51:54.8455649+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": "2024-02-28T07:51:54.8455649+00:00"
  },
  "modified_dateutc": "2024-02-28T07:51:54.8455649+00:00",
  "id2": 22
}