Retrieves all the locations

Request Information

URI Parameters :

None.

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": "8e1ebb84-4900-42c2-b29a-a03ff047ac29",
  "_parent_id": "fafdd396-8f20-4276-8552-1b4030827134",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "521f668f-cdef-4dd2-aea0-64c35eb2ca8c",
  "company_id": "db025bf1-5d8b-440f-9d6f-7ff8d6fe93c0",
  "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": "c3a813bf-1d8a-42e8-8c82-9adce2f87560",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "b9ec805d-2883-414e-b831-d2c853f2b440",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "dc62f1c6-a278-4ef5-9f77-94a296204cb8",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "4dfd9d56-615c-4393-bd50-18780f5534b9",
    "company_code": "sample string 5",
    "company": {
      "id": "4ba871ac-08ae-452e-8dad-69e62b8e3252",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2026-11-18T21:12:08.5321442+00:00",
      "sales_territory_id": "201865e6-c005-47b2-989f-f482911cc7ea",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "f25d37ce-3a07-4f44-b0ab-f8a2adc85b1f",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "e3d97566-8064-4024-a4c4-9b138afe31e9",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "d4346351-bd42-445f-8b5c-faeb435e46b8",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "4969f3aa-1ea0-40bc-83e6-75352814548c",
          "db_currency_id": "0e8fa7cb-391f-45bd-80f7-2b85c1f962ca",
          "db_language_id": "21baca0d-019b-4d30-a270-c710b6d87484",
          "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-11-18T21:12:08.5321442+00:00"
        },
        "modified_dateutc": "2026-11-18T21:12:08.5321442+00:00"
      },
      "marketing_segment_id": "a684539d-1365-4988-810d-3e2bcb97d418",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "3344ad52-1ad5-4b3f-9b4a-e8657a8df958",
      "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": "b0410b85-8b3e-49c3-b198-7f54443fa765",
      "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": "ab0fe1c6-f667-403a-98a9-2eff6915585f",
      "db_country_code": "sample string 28",
      "feelist_id": "af62ad31-de20-4a46-81bc-98814670cd94",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "96a156a4-8bf9-4ee7-85d9-121d97851efa",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "6e469754-a554-4b50-9d8d-94ac4c86adc7",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2026-11-18T21:12:08.5321442+00:00",
        "db_currency_id": "3247623e-e65a-4626-8eb5-6ae5cac67cc8",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "62b18586-5fd1-4650-8def-aa914cbd9a08",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "244a0d1e-b1b5-4ab4-a471-baf001ad3efd",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "2c5af005-70f9-43fc-92dc-2ae1d6efc316",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "c510b489-5e93-4fe7-bc3e-7e4a065a5418",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "1e3d3fc1-f368-4b75-a429-3f195dd4577b",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "93dcc209-39b4-4246-92b9-794b602dcccf",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "cb0e1590-b0ca-4760-8074-4b539b714493",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2026-11-18T21:12:08.5321442+00:00"
      },
      "company_sector_id": "5cc30edc-879e-4526-8591-424189cf0adc",
      "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": "7dd54cb3-b233-4345-acb7-6258f0228dd0",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "282bf6c6-1e20-492b-b90d-2aa4c33316f9",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "bd33c831-510a-4a33-bf86-254e638e57f6",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "694cb36f-8af9-4300-ac79-8cb17c3d2def",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2026-11-18T21:12:08.5321442+00:00",
      "id2": 60
    },
    "db_language_id": "bc70362a-64b1-4fb9-b9c7-54fd0cd7308f",
    "db_language_code": "sample string 7",
    "db_title_id": "c323823f-864d-4fe8-8ab8-7890d106c729",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2026-11-18T21:12:08.5321442+00:00",
    "create_date": "2026-11-18T21:12:08.5321442+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-11-18T21:12:08.5321442+00:00"
  },
  "modified_dateutc": "2026-11-18T21:12:08.5321442+00:00",
  "id2": 22
}