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": "b1e481c3-9133-41ee-8014-50c7717e9237",
"_parent_id": "c306823b-70d2-4b61-9251-223da5a1bb65",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b9bb8695-51af-4028-b53b-1b1f915c8834",
"company_id": "9c1df874-97d3-4d17-a777-fd714e1a2bc5",
"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": "5e7dc8da-4c7f-488b-b7b6-7682121dc4c6",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "aec2baa7-86d8-4ba7-afeb-53ffbeb05e85",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ecca3a42-3021-40e2-ad19-3becdf996eb5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e6a6bf92-ecff-4477-a8a3-4793b945add8",
"company_code": "sample string 5",
"company": {
"id": "101e3044-c4a2-4ba4-921e-6a3b974f6132",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-22T11:51:25.4946849+00:00",
"sales_territory_id": "e47c5b09-5423-46a8-9a2c-c9ecbffbd028",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8f11394a-8560-479b-8805-bc1db5564822",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "253957a0-84ac-46f1-ac95-72906d624883",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6f96d3e6-9041-414d-888b-a46eba00edc5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee7c0a73-4c86-43fe-a689-1da528ba1f4a",
"db_currency_id": "f56c92ba-8cc5-4923-8d63-7d3d17cc3995",
"db_language_id": "6475a600-480b-42db-82ed-c1c23c79d463",
"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-22T11:51:25.4946849+00:00"
},
"modified_dateutc": "2026-09-22T11:51:25.4946849+00:00"
},
"marketing_segment_id": "2249bbb7-2316-4b6a-a5da-b6e03eaa8076",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "34786c1f-df44-4d05-aada-c31dc6f01fab",
"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": "d4fcee3f-d00e-4bb3-ae3d-5335717f842a",
"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": "bfe77893-f0d2-4e7c-9afd-d7ab8e9cb005",
"db_country_code": "sample string 28",
"feelist_id": "6e4ae4ba-5d8c-46bf-8ef3-8a50275cff5b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "72d1f39e-7768-4bd1-9b8f-cb1f33c3add7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3f8cc245-c7ae-4bec-9f7a-701943fe7122",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-22T11:51:25.4946849+00:00",
"db_currency_id": "7e6c16e7-dfb3-4b5a-ae35-3daed279afdf",
"db_currency_code": "sample string 10"
},
"company_type_id": "1d87a35d-f671-47d5-b122-8bc83cec7d6d",
"company_type_name": "sample string 32",
"company_type": {
"id": "8c90f051-091b-4ed9-994c-861bdfd95572",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "370b4cc2-da06-4c47-af61-1aefd61ab4b4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "219c1f0f-c6a0-45c7-b6b6-68d3e44f7ade",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "833655dc-04ed-4440-82f5-eb070948765d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "58380721-b356-4226-890a-d84f1535c86f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3dab846b-6951-458d-926d-5d0c2b8772e0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-22T11:51:25.4946849+00:00"
},
"company_sector_id": "3d200c68-d752-42fc-907c-c7769241f089",
"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": "8c16b7ee-a01c-46f2-bf6e-26662b63c056",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d6c02c78-81e3-49f8-8625-202afdfcd94b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2db842a8-d8c2-4820-8df7-af89c288adc0",
"account_manager_user_code": "sample string 56",
"company_status_id": "c9748016-74ab-4428-a0f9-349f84b066b6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-22T11:51:25.4946849+00:00",
"id2": 60
},
"db_language_id": "9e39819f-d251-43f9-9265-6ff157eb3100",
"db_language_code": "sample string 7",
"db_title_id": "b82f1af4-925c-45c2-ba0d-fee20367f452",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-22T11:51:25.4946849+00:00",
"create_date": "2026-09-22T11:51:25.4946849+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-22T11:51:25.4946849+00:00"
},
"modified_dateutc": "2026-09-22T11:51:25.4946849+00:00",
"id2": 22
}