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": "da4998e6-fce6-45a4-81d2-32f6a4a30cf1",
  "_parent_id": "04552e11-d195-47a0-bf68-58fe692329cb",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "9ad668f1-a9ac-4faf-89bf-881ba236f4da",
  "company_id": "560e5d6a-d924-4741-8b4a-a61e7609b59b",
  "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": "ffe9c1bb-77ab-4e86-bd58-c0dd5ff9d6f0",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "b1d150e1-b473-4d4f-8143-1d4c937cb0d2",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "59744c53-e7da-49be-8d88-5894b3a5fb70",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "dfcee7c2-7b44-4baa-b94c-cbc11096eac1",
    "company_code": "sample string 5",
    "company": {
      "id": "efa30573-d45f-47d4-b5ed-ebbb6be3ac0c",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2025-07-09T17:17:51.4265986+00:00",
      "sales_territory_id": "1207d906-1c47-4874-b524-ada81a5222d1",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "6a6b4ece-c5f6-4a19-9873-8ee102a2b071",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "227e66b7-4740-428f-9b8d-40b207951d80",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "803d219b-6152-487f-a455-a21cdaa2a22c",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "f022ea85-251d-48c2-87bf-a8ab973fa6a2",
          "db_currency_id": "2dc16374-ae6f-4edb-9353-6085bcdf2172",
          "db_language_id": "8286eb8d-4b91-4fd7-af71-743943c1ddaf",
          "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": "2025-07-09T17:17:51.4265986+00:00"
        },
        "modified_dateutc": "2025-07-09T17:17:51.4265986+00:00"
      },
      "marketing_segment_id": "8ed0425d-d972-43dd-aef5-a5b0206ffa98",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "0af1c321-ea54-402e-af52-958c502c5f2b",
      "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": "0ce0289c-ff4a-46d3-8f20-d22884500172",
      "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": "ce9f3c37-8613-4982-a7ff-c2bc35d54b21",
      "db_country_code": "sample string 28",
      "feelist_id": "dfc9da3c-a300-4030-8870-b8bfda247829",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "aafd623d-a84d-48ab-acab-5363be317ea7",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "989830fa-f73a-4d40-8538-39fbd27de3e6",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2025-07-09T17:17:51.4265986+00:00",
        "db_currency_id": "664134d7-0bd7-4390-95b3-ce734aa73d63",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "1151f1b3-e583-4ecc-9ef3-cdcc8746cf50",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "66d04025-9693-4463-9753-bf5ade4df1bd",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "a78a18a6-36a7-4f33-a67b-356344dd1036",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "25b74620-ef0d-4691-aadb-306d081d91c1",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "615b191d-43f3-4b91-a101-baf4d96da84f",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "05c4271e-ce98-4af6-a1d5-2141a785cdaf",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "c7c44f53-ca93-4c59-9a62-133f1b5ee615",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2025-07-09T17:17:51.4265986+00:00"
      },
      "company_sector_id": "b3e97f2c-b5ac-420c-8009-e1de5c99cdf8",
      "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": "d77b627d-f2cc-4ddb-b625-62eaac8646f0",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "c4fb9545-11dc-4976-9386-ba9dbea7804e",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "b5bee93a-8345-4edf-9467-b9ab5f5874a7",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "1877e640-0e69-4317-b2f3-fba99cf9f565",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2025-07-09T17:17:51.4265986+00:00",
      "id2": 60
    },
    "db_language_id": "0b461970-2905-4d29-938c-dbc6507eefcc",
    "db_language_code": "sample string 7",
    "db_title_id": "5a1fa613-cf84-488f-90a5-e9533488f97c",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2025-07-09T17:17:51.4265986+00:00",
    "create_date": "2025-07-09T17:17:51.4265986+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": "2025-07-09T17:17:51.4265986+00:00"
  },
  "modified_dateutc": "2025-07-09T17:17:51.4265986+00:00",
  "id2": 22
}