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": "fc780fbc-ae03-43cb-b4e8-0ee1e87b1098",
"_parent_id": "04c22e61-f2d2-4e9f-a4ee-3e3ba59764d7",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "8fd5aa1c-8107-4908-b4ae-7c20d58beb0e",
"company_id": "04888e77-77d2-411c-a917-4a772dcbea63",
"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": "0057aeb3-ff6c-4fc6-bf6f-fea41ba352eb",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "cca3decc-e630-43b4-b1a0-4f74f9c625cd",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "eef213bb-d215-4f81-a88a-af06a4f47da9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "453c025d-d9c9-4cda-8eed-a3c115f30ccd",
"company_code": "sample string 5",
"company": {
"id": "d95c64a8-3956-47ed-b0a6-9d1e9ec6d8d0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-26T00:07:02.4991373+00:00",
"sales_territory_id": "f7c69083-b499-4b01-91d6-ec45a5d22410",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f5235e76-8830-4318-8d51-bd6b37c2bc80",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0a1e78c9-ae35-4050-8c16-200466d1f9ee",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bfc5dbf3-57b1-4a17-a7eb-1470d7886ca6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0be702ff-0b7e-47cf-9c55-b5f4265066fc",
"db_currency_id": "39636398-3650-4dfe-bf14-f39fdb3601db",
"db_language_id": "9bfdbc4c-eb7b-4438-84c6-6d52ea11481d",
"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-01-26T00:07:02.4991373+00:00"
},
"modified_dateutc": "2026-01-26T00:07:02.4991373+00:00"
},
"marketing_segment_id": "fcdbd75b-ebb6-471d-8a68-a7ee6decfdbd",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f8d6f309-507f-44b5-b3a0-1c2b4ed44731",
"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": "982892cb-95df-4dd7-bc2c-b96131d0b8db",
"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": "6266fd00-7d86-46d5-b2aa-23d4a2412d71",
"db_country_code": "sample string 28",
"feelist_id": "f2c59831-ffdf-4c8d-b59e-fc72f9a6e984",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7654a644-b71a-48ad-8cc4-33c48d51bb36",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8f236ac1-122a-4afa-bf81-6835276ea654",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-26T00:07:02.4991373+00:00",
"db_currency_id": "31dbaf3b-9956-4b05-822a-9e6aff369fc9",
"db_currency_code": "sample string 10"
},
"company_type_id": "928e96b6-ee9d-4cbb-8802-5c94aa8025f4",
"company_type_name": "sample string 32",
"company_type": {
"id": "fa2c6236-1527-460b-8e74-1ca90ebe103b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6da7e9fb-d5bf-417f-9acf-7f0e36c5716c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a39762d6-634c-4910-a8c2-fc346861fd07",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "123171e2-0f38-4991-ae43-3063616366c2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6556c12b-feb6-4242-9029-c8ea693054db",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e536b1cf-90f0-43e8-97b0-b41c16855e7b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-26T00:07:02.4991373+00:00"
},
"company_sector_id": "cc6cd7c5-9070-4fbc-bef0-4773396796b4",
"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": "7ef769d8-c71e-4213-ad34-bd170208bbd1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "129244ac-111d-4c25-a8e8-4f8a1f2ddb0b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7a6c65b2-4cae-4832-bb3d-bb829245c0a2",
"account_manager_user_code": "sample string 56",
"company_status_id": "48e5d028-1dbd-4297-b539-c8d763410502",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-26T00:07:02.4991373+00:00",
"id2": 60
},
"db_language_id": "08c5368e-d4b4-43fa-bcb9-e9fa591a42d2",
"db_language_code": "sample string 7",
"db_title_id": "d3bf194b-128b-4597-9e37-6039d8e8a4a7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-26T00:07:02.4991373+00:00",
"create_date": "2026-01-26T00:07:02.4991373+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-01-26T00:07:02.4991373+00:00"
},
"modified_dateutc": "2026-01-26T00:07:02.4991373+00:00",
"id2": 22
}