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": "56990d8e-9b10-49f2-b8d0-7275a27f3a2a",
"_parent_id": "9f081454-254a-4dd1-bc68-1dbb53c0196c",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "d90df09e-0a55-44d1-ae19-2229ea9424c1",
"company_id": "1e8b9d55-96d5-4588-8c8e-2b38ff77d464",
"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": "cef4ff38-75d6-43cc-8ae5-c57c67e6f7a8",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "cb17c438-86ce-4517-8fc4-416ec39c2968",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "0ec5ae21-f1b9-4aac-8ac0-7c165660d001",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0a792a80-75b4-4184-8b13-5b5216629a8c",
"company_code": "sample string 5",
"company": {
"id": "8a0eb221-fa81-49d5-85b9-6ed4dd6dd8c8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-15T13:12:54.0910676+00:00",
"sales_territory_id": "204763c0-4a4b-4190-a1ee-41459666bdb8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5ae3accc-a949-478b-ba37-d0a528fc5589",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f85d638c-d6f8-4f4a-8f59-b2db719955e6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "24ee3e1e-13ce-48b1-be2f-86387f7f7d89",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db2a4705-0f16-4852-b8e5-f25f97d6b403",
"db_currency_id": "476dc991-3d27-4720-91b6-305241fbeab8",
"db_language_id": "c21c09e0-1828-4e99-af09-eaf9d7d02fe1",
"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-15T13:12:54.0910676+00:00"
},
"modified_dateutc": "2026-01-15T13:12:54.0910676+00:00"
},
"marketing_segment_id": "ffb48219-8636-44cf-90f3-2295f7ee2554",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "35fd6998-8aa0-40c1-9965-8e65cf2dc5fc",
"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": "94f9155e-23a0-4816-ac33-b731632cc238",
"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": "6d0cbb9d-377f-44b7-aa88-e4e359355aa8",
"db_country_code": "sample string 28",
"feelist_id": "6d402d70-c56a-4195-a438-67dd005cf484",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "dc12d8df-6412-415f-b375-27de6a242d88",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1810e705-84a6-4348-9899-a331ca09e12c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-15T13:12:54.0910676+00:00",
"db_currency_id": "40229b5f-fdbe-4a0a-859e-ef5a07f33cfb",
"db_currency_code": "sample string 10"
},
"company_type_id": "9973bf39-d07e-48c4-9a0a-bea56579efd6",
"company_type_name": "sample string 32",
"company_type": {
"id": "3912ba46-a593-45c2-b3ff-c935519c7001",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c0652c9b-116d-4df7-b119-2699939e7e18",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7be05016-7b0f-431d-a1ea-b9b50fea7a63",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b5ff7df4-9b03-4833-96f6-c51fe5eba0eb",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bd805335-87f1-4b7e-ab74-c18fe0af28bf",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "724815e6-ad39-41b0-9939-4205c5e35087",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-15T13:12:54.0910676+00:00"
},
"company_sector_id": "7f619420-a33f-4838-ae26-f9d9c24a2534",
"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": "0621cb48-6f78-46c1-bfb6-7e3911d9aa5c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5e1da8f0-0f64-4054-ae0b-af1d6ac87473",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c836cd10-9068-434f-844c-66419cd80e85",
"account_manager_user_code": "sample string 56",
"company_status_id": "3e8630a4-f149-4e6c-88be-8cbd48ebc605",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-15T13:12:54.0910676+00:00",
"id2": 60
},
"db_language_id": "3ad0fbcb-3b5b-45d4-bb80-0fda5a729a79",
"db_language_code": "sample string 7",
"db_title_id": "9d81e5da-3cfc-472a-8beb-df83119745a6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-15T13:12:54.0910676+00:00",
"create_date": "2026-01-15T13:12:54.0910676+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-15T13:12:54.0910676+00:00"
},
"modified_dateutc": "2026-01-15T13:12:54.0910676+00:00",
"id2": 22
}