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": "a9fd5103-b0a3-40b9-a7f1-526185a00f4e",
"_parent_id": "3301cecf-bc7d-4e5c-bf4a-a89008eb9971",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "508df9d5-5fa9-4d56-8105-8c58d9424b9b",
"company_id": "b1db0262-76a7-4333-a83a-40b7c9908741",
"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": "18588304-f4e2-45b6-a24b-d79920faa32e",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "77e50424-213d-4226-bde7-64ca30a185ae",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e8a0df12-43b6-4393-861c-3339d3934693",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8a7da2f5-cc9f-4599-8b4b-ed0635af4023",
"company_code": "sample string 5",
"company": {
"id": "347f8cc7-a683-4a6d-b953-48daed694965",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-18T21:23:21.2142689+00:00",
"sales_territory_id": "f463afab-d09e-40fc-baf9-d49dad642b55",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4a80bfc3-e7a2-4fc3-9d18-d976ca01d8c1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "71479eef-8ca1-497e-a963-3f530eb501bf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "198763d3-fa4f-48a3-b731-6d6056628489",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa17f32e-1d48-4907-9b13-27a748c191a6",
"db_currency_id": "fc6cd33e-1682-4a7a-91fe-2c6115c0a5f4",
"db_language_id": "cde649fa-667c-4d72-92b2-fe87dceb806b",
"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-09-18T21:23:21.2142689+00:00"
},
"modified_dateutc": "2026-09-18T21:23:21.2142689+00:00"
},
"marketing_segment_id": "f4b1a708-fb77-491c-baf9-dc4ea72dd660",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2bab3955-ecc1-498a-b995-9025c85c1e0d",
"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": "52538c5e-8a35-49c9-8ce8-01262ef5f6dd",
"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": "3d3ebbf7-2be4-44f6-9970-63289e7cf544",
"db_country_code": "sample string 28",
"feelist_id": "6bda7554-641a-466e-b18c-512126f86950",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "575f7f82-445c-4555-8b65-0b7f50323ef7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b99d8065-0de5-4058-8761-bcc457b758d8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-18T21:23:21.2142689+00:00",
"db_currency_id": "30c1e723-aebd-4923-83dc-d4573bcf2c54",
"db_currency_code": "sample string 10"
},
"company_type_id": "1d7f8154-2a05-469b-8b5c-32eeff062059",
"company_type_name": "sample string 32",
"company_type": {
"id": "da961893-3f83-4f41-8473-5151a07488dd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "630a99a1-50dd-4ab7-8c54-0d28338d38a3",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0e83e716-212f-4ef1-843a-f97a30997700",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5eae4438-1679-45e3-b70e-4499b08ba8fa",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9d0382ec-21db-431e-b1c3-79aa9cbbe563",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "81dfa8de-8c6f-49f8-a3b5-c95f1c9786a6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-18T21:23:21.2142689+00:00"
},
"company_sector_id": "dd1dda08-165d-4d41-86a9-344b50a44ac0",
"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": "daeb3616-074b-4496-b176-b1673e02b109",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "16e44c1f-b674-445a-857e-f91aa7677dbe",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "07fe5755-7538-4f92-bda7-6d393ab6dfbe",
"account_manager_user_code": "sample string 56",
"company_status_id": "0f627e41-1dc8-4100-b412-966addc4b27b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-18T21:23:21.2142689+00:00",
"id2": 60
},
"db_language_id": "1abfaeea-3088-4529-be60-dbf1b008234b",
"db_language_code": "sample string 7",
"db_title_id": "533ec67c-46da-4ccc-bb0b-d5182cd49eba",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-18T21:23:21.2142689+00:00",
"create_date": "2026-09-18T21:23:21.2142689+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-09-18T21:23:21.2142689+00:00"
},
"modified_dateutc": "2026-09-18T21:23:21.2142689+00:00",
"id2": 22
}