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": "972ee6db-fc7d-49fd-a27b-4165233ef52c",
"_parent_id": "8dfc0a9f-d8cb-42a6-8476-3ebab5b1ba32",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9c564104-d96d-4faa-88ee-dfa375596318",
"company_id": "6b2f4653-e40e-4e85-a62a-afd1d72004b7",
"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": "6a1f544f-699d-42df-8ddf-26155b11e7c3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "4ca41505-e848-4da4-9633-0da657ff2787",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "1f20648d-3fd6-4cd9-8981-fe81875f61f1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4893632c-5d82-4c57-99b1-b0c03b40c19e",
"company_code": "sample string 5",
"company": {
"id": "62e34e10-a634-4972-96eb-df8ef516c9d6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-02T03:44:50.3104032+00:00",
"sales_territory_id": "bfd71140-9c26-47cc-b816-01d78f4c9d8e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "37951363-ceb9-4af6-bf9d-05795ab89238",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "11680499-4905-45c6-83ee-28cafa8e7805",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ac6ca9b2-fee4-412f-ab94-fe79b7e61e6b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dade1945-5012-4f42-a4c7-dd53badd2ea7",
"db_currency_id": "b42c9b3c-2176-410d-a1ba-9a3e203d8789",
"db_language_id": "b46ac0c0-604f-4847-9561-3bf856cb3e7e",
"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-07-02T03:44:50.3260232+00:00"
},
"modified_dateutc": "2026-07-02T03:44:50.3260232+00:00"
},
"marketing_segment_id": "0e8d5531-a0dd-4f9d-83e0-8769f729c3de",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "048cedc8-2e88-4596-a7ef-983923a25a0b",
"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": "8a4f8e47-4f87-4a58-b52e-3d50ed4422d3",
"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": "1e2cffd8-8238-45b5-9359-09caf23e1a7a",
"db_country_code": "sample string 28",
"feelist_id": "dc8440a1-86f7-4764-93d8-2ea35c5b1a45",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8b42ed59-ec7b-4416-be85-26fb2c5981e2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b27dfb2d-f1a7-4bd9-a31f-3c59d0d05065",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-02T03:44:50.3260232+00:00",
"db_currency_id": "7add6ab6-9b6c-4454-9d2b-2366b9c977de",
"db_currency_code": "sample string 10"
},
"company_type_id": "b142f898-8c31-4938-83b7-5cbf75730a2c",
"company_type_name": "sample string 32",
"company_type": {
"id": "d66a97e3-ef05-4029-9298-18213cdf30f6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2979eefb-723c-4d64-9ca8-18e10220ac0d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "664c4b34-9ed4-4233-b373-ab0781c3d914",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fac0221e-3a59-46f7-bb3a-327458c05b27",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "be01e8e1-a46f-48f4-a296-6cf9387cbe3c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1d81e7ea-4ad4-427c-8b1d-1908284b8a84",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-02T03:44:50.3260232+00:00"
},
"company_sector_id": "816c7dcc-fc1a-4d3b-8cd5-8f55bee1f999",
"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": "42237522-ef22-48d1-ade6-0865412634c6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "596382d3-463f-43db-8ca8-67d8da4dd807",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7d149b11-daed-4cb4-bb1b-e775eca32b2e",
"account_manager_user_code": "sample string 56",
"company_status_id": "789dd6c0-e2ea-4d40-9bf0-f8f1f0d5f9c2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-02T03:44:50.3260232+00:00",
"id2": 60
},
"db_language_id": "cb8d407c-aa7c-472e-ba29-b76080e8cbb9",
"db_language_code": "sample string 7",
"db_title_id": "502f9571-9183-411b-8b6e-adf1b92a1c44",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-02T03:44:50.3260232+00:00",
"create_date": "2026-07-02T03:44:50.3260232+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-07-02T03:44:50.3260232+00:00"
},
"modified_dateutc": "2026-07-02T03:44:50.3260232+00:00",
"id2": 22
}