Retrieves all the locations
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
location| Name | Description | Type | Additional 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 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": "c19158b2-a635-455d-a0ad-6bc4c5a18d0c",
"_parent_id": "c4ce83e7-a42f-44e8-ba09-b36f02fa4b66",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "7f59c448-deec-414f-a1b2-597e806563ed",
"company_id": "b6d67cb2-b33d-4c55-917e-66da11702845",
"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": "becfbb9b-f88c-45db-8919-5141399b3d2f",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "771bcc6f-a751-4d25-8953-3c2dfe941bb0",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e842ae5b-748b-4234-a190-393100f9b5ec",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b3cb2d07-0025-437b-8d23-ac63300c02c7",
"company_code": "sample string 5",
"company": {
"id": "ac20ca90-fadc-4439-878e-eb3bdf890efb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-18T23:24:21.701727+00:00",
"sales_territory_id": "b530ae43-d7dc-46d4-bed7-6e52eeb90f11",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "51ccc3e1-6538-4275-b508-756d64959cf1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7b54e07c-7349-4f4f-a59f-2906755e11ea",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d1185bea-7275-4ea8-89ec-b753b3b1d1c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "18b35ba0-8a7c-4c33-8fc7-479cf50a9ed7",
"db_currency_id": "9e28088a-80a0-4f64-a160-ff69b32fee0c",
"db_language_id": "f8823bd0-0072-4ebe-888f-b33543a443f4",
"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-18T23:24:21.701727+00:00"
},
"modified_dateutc": "2025-07-18T23:24:21.701727+00:00"
},
"marketing_segment_id": "bc8a3e12-8642-417b-a993-5cd7d1159bbb",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "863bda63-408a-486d-ac47-35fa36030726",
"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": "17f77c49-93ad-4a9a-8ab2-d0bbefd90064",
"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": "415c07c0-b655-4daf-88fb-53e2adccb3f4",
"db_country_code": "sample string 28",
"feelist_id": "83d0ea3e-84b4-48b4-807e-2be855aafb5b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "caf34c0d-49c8-4275-942c-da9923f128f6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c0663f02-1f12-4aa8-a347-0205192e1109",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-18T23:24:21.701727+00:00",
"db_currency_id": "42e7aafb-8799-4458-a4e9-042dc6982a8f",
"db_currency_code": "sample string 10"
},
"company_type_id": "12419d5d-c683-47af-99a0-a35c2b4282d7",
"company_type_name": "sample string 32",
"company_type": {
"id": "7d8250ca-878e-46c3-96cf-71150127e311",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7540bc64-40d3-4e80-948e-ea8c2ed95641",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c73da71d-fbf6-4b6d-997e-73f43cb6493b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "076e3842-72b8-433d-93ee-5b3d54f441e1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7ad2e1f3-bdac-412b-bc44-c36803fdbc73",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5e719f15-debf-41f8-ad69-3c174a907b20",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-18T23:24:21.701727+00:00"
},
"company_sector_id": "4b71ab5b-6198-43fb-b504-cc4a32d44545",
"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": "6dd5951f-bd5c-4a39-ab0f-8dd9bf09e1f0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "af10d8b4-6621-4fb1-9edd-fedbd748ee25",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3cd390d6-acf5-474c-933b-7eaccbb3c597",
"account_manager_user_code": "sample string 56",
"company_status_id": "31f28af4-25b2-4e2d-8b24-74820afbfdab",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-18T23:24:21.701727+00:00",
"id2": 60
},
"db_language_id": "4a1aea85-599d-442a-9f0e-d5ed7993c46f",
"db_language_code": "sample string 7",
"db_title_id": "1ec45fb0-1b67-4597-903b-17590d670abc",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-18T23:24:21.701727+00:00",
"create_date": "2025-07-18T23:24:21.701727+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-18T23:24:21.701727+00:00"
},
"modified_dateutc": "2025-07-18T23:24:21.701727+00:00",
"id2": 22
}