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": "7639a7b7-74c5-4633-996d-227074fb8500",
  "_parent_id": "9af6d9ff-45b5-4d8e-a5e6-1ab799b8ab39",
  "_parent_reference_back_office": "sample string 3",
  "project_status_id": "2dfcdced-54cd-41e1-9c54-5a53da0ea7f5",
  "company_id": "dbb798ef-e004-4c8c-a6cc-ec9b6f914beb",
  "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": "7c48d904-8418-4134-809d-e97617759f4b",
  "db_country_code": "sample string 17",
  "street2": "sample string 18",
  "latitude_decimal": 1.0,
  "longitude_decimal": 1.0,
  "contact_id": "4e089e5f-a56c-4ffd-9617-766bbdea4ff3",
  "contact_reference_back_office": "sample string 20",
  "contact": {
    "id": "018a4b60-66fb-4fd0-b6bb-e9981ace385f",
    "firstname": "sample string 2",
    "lastname": "sample string 3",
    "company_id": "bc4892c2-72cc-4f8e-b6c2-d57653c048ad",
    "company_code": "sample string 5",
    "company": {
      "id": "55838e18-51bf-4344-baa5-24444ad95c9c",
      "is_client": true,
      "is_supplier": true,
      "archived": true,
      "name": "sample string 5",
      "notes": "sample string 6",
      "create_date": "2026-11-16T04:11:22.6830684+00:00",
      "sales_territory_id": "77b9263b-950d-4a83-aa27-5b9c3a1c08cf",
      "sales_territory_code": "sample string 9",
      "sales_territory": {
        "id": "7b878b01-67c6-4727-aa1d-617e72b3fee4",
        "code": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "c0d1c198-39b9-4a14-a83d-33985d944e52",
        "sales_organization_code": "sample string 5",
        "sales_organization": {
          "id": "a1211f54-018a-4b47-828e-3b2d5202ae09",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "bdb0b2ed-dbfe-49b6-882b-9674908c825b",
          "db_currency_id": "abb8d914-ff5e-4e3e-a7c0-01f6d0f196ec",
          "db_language_id": "a14ffcfd-7983-43a1-985a-d9808418ad2c",
          "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-16T04:11:22.6830684+00:00"
        },
        "modified_dateutc": "2026-11-16T04:11:22.6830684+00:00"
      },
      "marketing_segment_id": "d54f0900-aac6-47c3-9057-322e91a5bbaf",
      "marketing_segment_code": "sample string 11",
      "sales_organization_id": "1be2696d-0ea8-4ab0-90dd-6d7abe98ba01",
      "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": "4d119ee9-2b28-4181-b3f6-e90f991a7d11",
      "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": "c8b2dea3-ea3d-42b8-ad9d-1f364bd69d62",
      "db_country_code": "sample string 28",
      "feelist_id": "2b6fcdca-b7e1-4953-baca-987f9004b311",
      "feelist_reference_back_office": "sample string 30",
      "feelist": {
        "id": "4f6b3458-5d08-4cf9-ac70-11ad6f6a221f",
        "name": "sample string 2",
        "description": "sample string 3",
        "is_default": true,
        "default_price": 1.0,
        "sales_organization_id": "0294c59a-3932-4a28-8f0b-8252d8d80a97",
        "sales_organization_code": "sample string 6",
        "reference_back_office": "sample string 7",
        "modified_dateutc": "2026-11-16T04:11:22.6830684+00:00",
        "db_currency_id": "05811556-ac41-4cb9-92e2-3661d53f045e",
        "db_currency_code": "sample string 10"
      },
      "company_type_id": "399b0449-f9c7-4d7e-b044-c1a455d0ed98",
      "company_type_name": "sample string 32",
      "company_type": {
        "id": "5bfde5ae-b0f1-45b8-bf41-31d7c78fad8c",
        "name": "sample string 2",
        "description": "sample string 3",
        "sales_organization_id": "12d59c1b-dab5-442f-b06d-ef77f299387d",
        "sales_organization_code": "sample string 5"
      },
      "db_language_id": "69562ad1-79fe-4def-a44b-42f247b2a42b",
      "db_language_code": "sample string 34",
      "code": "sample string 35",
      "article_price_label_id": "83bfa866-1502-44ce-82a8-bb6c72a9408a",
      "article_price_label_code": "sample string 37",
      "db_payment_method_id": "b8938ae4-103f-406b-b20e-75ada9873547",
      "db_payment_method_reference_back_office": "sample string 39",
      "db_payment_methods": {
        "id": "3f92d3d8-83e3-428c-8f8c-47d969d8d9db",
        "name": "sample string 2",
        "description": "sample string 3",
        "reference_back_office": "sample string 4",
        "activated": true,
        "modified_dateutc": "2026-11-16T04:11:22.6830684+00:00"
      },
      "company_sector_id": "859acad6-5539-486c-b810-545414ea35f3",
      "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": "e8a47e56-6c71-400e-a0c8-0c174b307fd7",
      "service_manager_user_code": "sample string 52",
      "finance_manager_user_id": "150c5f3f-77d1-4c55-8b06-2672ee029be4",
      "finance_manager_user_code": "sample string 54",
      "account_manager_user_id": "41f80bb0-9021-43ce-b9fb-74e47b183e1b",
      "account_manager_user_code": "sample string 56",
      "company_status_id": "73a19812-1cda-4e46-aed2-224fa3b184c7",
      "invoice_email_to": "sample string 58",
      "modified_dateutc": "2026-11-16T04:11:22.6991122+00:00",
      "id2": 60
    },
    "db_language_id": "db83b413-9870-405c-93ee-1b306cbb4ae7",
    "db_language_code": "sample string 7",
    "db_title_id": "7c7bd7ef-1adc-431c-ac98-3b1ae0ab6d1c",
    "archived": true,
    "functions": "sample string 10",
    "e_login": "sample string 11",
    "e_password": "sample string 12",
    "notes": "sample string 13",
    "birthdate": "2026-11-16T04:11:22.6991122+00:00",
    "create_date": "2026-11-16T04:11:22.6991122+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-16T04:11:22.6991122+00:00"
  },
  "modified_dateutc": "2026-11-16T04:11:22.6991122+00:00",
  "id2": 22
}