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": "956cc203-4889-4fea-9d37-4a6e8c83f14d",
  "_parent_id": "d371e73c-dd34-45a6-92f6-91fbd16b9b40",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "4a4bc55d-929d-4bdb-b1fa-9e326829b205",
  "company_id": "5180e5bf-f5c9-4137-bcb8-5169c89d2398",
  "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": "e15fdf39-24a7-4f8a-8f3c-fb2a1addba1b",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "adaf33da-91ba-4218-9b22-bfeb55d0f9e6",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "0e4467a9-dc4f-4ddf-909d-5e06c51fd591",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "10a4a791-1126-4e9f-bb56-a5748682e8c0",
    "company_code": "sample string 5",
    "company": {
      "id": "6c308eda-d3cc-4c64-ac46-9aa9362fffcc",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2024-02-24T01:55:26.0487623+00:00",
      "sales_territory_id": "7d740355-c7d2-4130-a165-af41bc06af06",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "0e3c0151-25e0-4790-89cb-0ab24cc182e6",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "fb72fd77-d40d-4e3c-a21a-506b6ba0d67a",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "0fb71bf9-4314-4a86-a98e-81c6f7a52a30",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "0333994a-c9fd-4ff4-b39d-76227867a452",
          "db_currency_id": "241a7c02-5677-45bb-9161-82ef18abe66c",
          "db_language_id": "ab1d4fdc-5bde-4bfd-89ca-39a0310dab54",
          "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-24T01:55:26.0487623+00:00"
        },
        "modified_dateutc": "2024-02-24T01:55:26.0487623+00:00"
      },
      "marketing_segment_id": "8768c845-2e23-48d4-b307-a4212ca4c17f",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "7d905cad-fe4f-4a63-8680-cf6bcc09a6f7",
      "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": "d7d38460-c54b-41b0-aaf1-2cda209e6a72",
      "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": "977150e2-b586-4f73-8cb1-d97161d3b22b",
      "db_country_code": "sample string 28",
      "feelist_id": "ae5bd755-72a0-493a-a74f-7b1774622b70",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "ae64a9e7-6f6e-4a03-944e-113926bc6da1",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "736b0835-1b89-4e2f-ae43-0087f9da10bf",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2024-02-24T01:55:26.0487623+00:00",
        "db_currency_id": "bba43a4a-0fae-47f8-ae06-7bb5f8b28de0",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "6b1fac01-2181-4190-bec1-90c1f7c28804",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "5b316f1c-478e-4f97-8aff-b0246ac66f1b",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "71562c5a-ad74-4975-bbad-6d6ed142ee00",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "b22ab93c-f0ec-43d3-9d13-ca82cd30201f",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "24944a0e-c0bc-498f-a3c5-3294f35dbdaa",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "66142c80-8628-4537-b3db-b795a882751d",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "76709d10-6bac-4578-b10b-f4adaf01d23e",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2024-02-24T01:55:26.0487623+00:00"
      },
      "company_sector_id": "a7523940-9cf5-4df8-bb93-4b9fef9ca31b",
      "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": "3c513930-d956-4b43-a4b0-c5e7c98643c5",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "5e1c144e-907a-4247-9f40-0adfe371a6f2",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "97f77f3b-5941-40c6-a641-7b873999d184",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "7f74699a-1485-469a-8d34-752c384bb7f2",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2024-02-24T01:55:26.0487623+00:00",
      "id2": 60
    },
    "db_language_id": "08513465-0d63-432f-9583-89da735112fc",
    "db_language_code": "sample string 7",
    "db_title_id": "ce3ba74b-8401-4d2d-b956-4ce3c1567a2a",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2024-02-24T01:55:26.0487623+00:00",
    "create_date": "2024-02-24T01:55:26.0487623+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-24T01:55:26.0487623+00:00"
  },
  "modified_dateutc": "2024-02-24T01:55:26.0487623+00:00",
  "id2": 22
}