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": "6af17d08-ad4f-4ca1-81e0-edff5624a81f",
"_parent_id": "0bfa7286-3bb2-49cf-845e-df0ea1cde9d0",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1d5a6d3b-1a77-4e2c-9a45-396425b9d84f",
"company_id": "6415e699-342e-4835-9d94-fc2fd4f43e9a",
"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": "a29397b4-6c31-4dbd-a777-b02b8aeefafa",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "83992e20-e55a-403c-923c-e02e32ee4a68",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6369252e-a804-401c-8352-76f3d6b81212",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3d6e87af-83b7-47bd-af27-538c97f53c1f",
"company_code": "sample string 5",
"company": {
"id": "7f7f1c73-1040-4fe9-911a-97a675e3fe92",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-09T22:27:37.0969136+00:00",
"sales_territory_id": "ac541dae-9778-49a7-95bd-33805889e305",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f314aedc-d746-4adf-8bec-4c1c7b561db4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cb89944e-b03b-4b50-9c12-11364f1eefb7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bf95a05d-6033-4ad4-b06c-bec3a622f0e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2571c061-a274-4322-afcd-764fa388e267",
"db_currency_id": "18297fa4-bdc9-4092-9016-a27432f2a752",
"db_language_id": "ee5205e9-940c-48b4-affe-005ff025efe5",
"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-09T22:27:37.0969136+00:00"
},
"modified_dateutc": "2026-11-09T22:27:37.0969136+00:00"
},
"marketing_segment_id": "43d68ec1-38a7-4c53-8a5f-6bc95ed6c1b4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1351d4ef-eb05-4c0e-9be9-5bb88fdad790",
"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": "8045d956-462b-4c4a-810e-066a48a920f0",
"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": "f32df8bb-cb46-41ca-8a3a-439e60586cc1",
"db_country_code": "sample string 28",
"feelist_id": "00ec7f12-0035-4ace-b341-84c547ce72fa",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "346e8626-5ed7-4334-8a6f-fc5209a3c5ae",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c67609ed-8213-4a7b-858f-7403efac5e2c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-09T22:27:37.0969136+00:00",
"db_currency_id": "2cf39d06-511b-47f9-b15c-7eb61f86c747",
"db_currency_code": "sample string 10"
},
"company_type_id": "3bf65439-7197-4a9f-9010-ff83c192e4d5",
"company_type_name": "sample string 32",
"company_type": {
"id": "76c15106-09bd-44a9-9923-2536ba82038a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "63fd38ca-4986-4d46-a70e-0ccf363737ae",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6523023c-20d4-495a-9f5f-ed5dd6019d6e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9f33ca5f-0055-48c3-a835-8524878ea538",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3609931f-768a-454f-b6c6-eca027d61235",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "84e94744-dd85-4eaa-9132-f7b7433d6027",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-09T22:27:37.116265+00:00"
},
"company_sector_id": "88dc868a-7ba7-4e3c-8dd4-2326e8313d4e",
"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": "829aada5-4921-4810-8ee8-1a1cf97b22f7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "41bb278e-eca3-4c15-a6ea-383ccb788224",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bff66949-98d3-4db0-96c7-96610d2ebd6a",
"account_manager_user_code": "sample string 56",
"company_status_id": "cc0d721c-dc3d-48f5-8626-d240677bb514",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-09T22:27:37.116265+00:00",
"id2": 60
},
"db_language_id": "fe03e93d-0223-44d3-86fe-5e9c46612ca1",
"db_language_code": "sample string 7",
"db_title_id": "d491c3d2-5ad4-40fb-8455-c7c9bb843747",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-09T22:27:37.116265+00:00",
"create_date": "2026-11-09T22:27:37.116265+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-09T22:27:37.116265+00:00"
},
"modified_dateutc": "2026-11-09T22:27:37.116265+00:00",
"id2": 22
}