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": "7ee78d6f-0955-4c50-a7f1-3b5b21feac41",
"_parent_id": "5e1c29ba-403a-4e75-a03e-6587a819d105",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b32057f9-353d-4844-9cdd-495b8e941c1c",
"company_id": "47b287d6-1873-4323-8119-eec3c579399e",
"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": "fb8184ef-84ad-4eae-9f50-f69230f8de00",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "d789ce6c-5dca-4a82-9988-ce3425191dd5",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6cab6d7d-db79-4c3f-84ca-589c222e8317",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9fbc5dcc-129b-4bf7-a2a9-8dbb8af4c671",
"company_code": "sample string 5",
"company": {
"id": "6a39d7d3-6e45-4714-8e6d-7c894d6df2c5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-01T17:47:41.615347+00:00",
"sales_territory_id": "c118d52e-796f-4ca3-9ed8-49e3836fbe42",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d3e5cd1e-048c-4d8a-89c6-a5b79026a8f9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3b772bea-bc11-4f8e-9f69-c2bc7b5d510c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "55bdae73-6486-4e40-a513-072565fef6cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf289f58-5d2c-4a36-87a9-07664e53a06b",
"db_currency_id": "6459466b-7858-47d2-b31d-6ffadc66a907",
"db_language_id": "53a730f6-5c89-47d3-851c-9507be0e0f59",
"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-10-01T17:47:41.6322867+00:00"
},
"modified_dateutc": "2026-10-01T17:47:41.6322867+00:00"
},
"marketing_segment_id": "532298c5-a52f-4127-8d67-a19a8d6db847",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "48b5acb6-1b26-43fd-bf73-e6de20e77b92",
"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": "66ac82d0-4f9d-449a-a2d5-dbc9bc1294e7",
"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": "8f8b4779-1e0c-4348-b190-6a5c7ff5bcae",
"db_country_code": "sample string 28",
"feelist_id": "e2f520cd-a210-4842-b38d-c4265a50b352",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "069e36e1-1f84-48ba-bffd-47a8b274f4fd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d8b465be-6510-4f63-9cd2-983e17421e00",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-01T17:47:41.6322867+00:00",
"db_currency_id": "1689cc28-7864-42ee-9b6a-b5d6f1a36204",
"db_currency_code": "sample string 10"
},
"company_type_id": "f649d08d-0536-4a3e-a707-4b1e6eaf3205",
"company_type_name": "sample string 32",
"company_type": {
"id": "e1718709-8303-4be0-af70-eb9310355522",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "463c9d5c-368f-423f-870f-ca12cf3a5dd1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "38098c69-053d-4ff0-8549-49f33c46e824",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "188b2e6c-68ba-4182-8c2a-486afdd0b55b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "91af700e-6918-4b70-a48c-94966042d572",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "872cd3d8-86e5-4bc0-bd4f-86bfd16e09c9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-01T17:47:41.6322867+00:00"
},
"company_sector_id": "375ae652-93bd-4366-ab5b-89e81be80611",
"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": "192f3419-c25e-43b9-a7ec-be28be9fe1fa",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "79820ee6-3221-4686-b850-35195f10d517",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "47314e7a-a43d-4715-af5f-d45efc8896c5",
"account_manager_user_code": "sample string 56",
"company_status_id": "07baabd7-88eb-4068-92fb-c226395b51b2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-01T17:47:41.6322867+00:00",
"id2": 60
},
"db_language_id": "b6d64cb1-125a-4b20-a054-823f34ea74eb",
"db_language_code": "sample string 7",
"db_title_id": "b8a2554a-5c2f-49ff-a5de-10d36f509a7a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-01T17:47:41.6322867+00:00",
"create_date": "2026-10-01T17:47:41.6322867+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-10-01T17:47:41.6322867+00:00"
},
"modified_dateutc": "2026-10-01T17:47:41.6322867+00:00",
"id2": 22
}