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": "29845143-d11b-4b42-a03a-6c1bc60ac7b1",
"_parent_id": "dd562562-d0b7-4f7e-a53e-fc9c1670d490",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "14a41739-2c93-40e8-8dca-f2537270f07d",
"company_id": "14f228b5-d290-4aa8-9833-3d0a237f8154",
"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": "fa80fe7b-b907-4e51-94d6-37a9ea5cbb80",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ec45d6ae-636e-4ace-99d2-8128dff2213d",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "580fa651-6f99-4e7e-8ad3-c89df933640f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3cc0210d-307f-4222-85f1-921fe919620e",
"company_code": "sample string 5",
"company": {
"id": "be3d0950-4226-4414-932d-0ac0775ce77f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-08T01:51:47.1051606+00:00",
"sales_territory_id": "187ea313-18c2-4959-8c11-db85d6b6af39",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "89565ebf-082f-454c-b022-cdf6ab069276",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ce171f63-9a46-4fe3-98a2-1cb70a3d1127",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "78074e83-8544-42c8-a2c5-6fbc9a8a5cd3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d855ab4-70fd-447c-aecd-2a4573e22962",
"db_currency_id": "8be686a5-9872-45b9-83ed-9e246d51c5bf",
"db_language_id": "a39c1904-79aa-4431-a0d1-2b2cf5e336c4",
"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-11-08T01:51:47.1051606+00:00"
},
"modified_dateutc": "2025-11-08T01:51:47.1051606+00:00"
},
"marketing_segment_id": "95cbadba-12ff-4f6c-800d-8dab20c0b852",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "07e6a34e-3952-4474-a6ec-bd477cabfea0",
"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": "3d00d3f5-a0a8-455e-8793-bb6d341c40b2",
"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": "000def22-8be7-42dc-a295-cce3bed91ec8",
"db_country_code": "sample string 28",
"feelist_id": "eb6853ff-88ea-48ee-9fb1-56c19d0d2698",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a0dfb65f-d9d6-4d7a-b2b9-83d84c27991f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8c4eaf38-3241-4110-a00c-153a94a204c1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-08T01:51:47.1051606+00:00",
"db_currency_id": "566c463d-7b92-4b54-8d3c-ecb08c1cef98",
"db_currency_code": "sample string 10"
},
"company_type_id": "75c2587a-dd69-4519-bf20-efec6212685b",
"company_type_name": "sample string 32",
"company_type": {
"id": "273416b5-d826-4567-8e62-0614a4026665",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2523f0f3-6e28-401a-a8e9-25a052a307bf",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d05a497f-87b6-46f1-80b3-3808e5aec369",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c67c208e-4bc3-4fca-a477-712a09be6db8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "60319096-a558-49e4-b014-3f047d6e344e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9db0cde3-46c2-465b-b2a4-583b2ed06c50",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-08T01:51:47.1051606+00:00"
},
"company_sector_id": "f4a863c4-bf03-441c-8586-18ae35aedb78",
"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": "53e4b0e5-fc30-491d-a7b8-30b66f715782",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ef9ee4dc-16cc-4239-a989-e466b6fe8c6c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d73878ff-b51b-4f46-be42-cdc4048696fc",
"account_manager_user_code": "sample string 56",
"company_status_id": "6e96be1e-8300-4c52-a3b0-1a9a144da612",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-08T01:51:47.1051606+00:00",
"id2": 60
},
"db_language_id": "bc2718fa-796f-4c8c-a118-32bc7e022cf4",
"db_language_code": "sample string 7",
"db_title_id": "7951485a-1cb8-4b70-9c17-181a115ec6db",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-08T01:51:47.1051606+00:00",
"create_date": "2025-11-08T01:51:47.1051606+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-11-08T01:51:47.1051606+00:00"
},
"modified_dateutc": "2025-11-08T01:51:47.1051606+00:00",
"id2": 22
}