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": "02f50436-8faa-4baf-a004-5b1d7891c841",
"_parent_id": "db4d4559-5544-4509-8b14-85c86a3734e5",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a5ba978d-c6d7-4bbd-84ff-7b7568545c04",
"company_id": "667fb144-36e1-4f21-afcb-bb8f77a799a3",
"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": "3b66930c-ed9f-46b7-bcee-c969b1f2bac0",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "1f6d7988-b237-41b1-a5aa-06569eaa35d5",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "8781b49b-a433-4d54-b517-8ced15a41fbd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d2c82e7f-d915-4f49-8c6c-eeedf0a0e3a3",
"company_code": "sample string 5",
"company": {
"id": "6581fcea-b9e1-41dd-90e4-86db4a1315e7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-29T16:02:43.3688588+00:00",
"sales_territory_id": "b3e3401c-9f70-44fb-8f2e-cfa940ebe336",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "29008d90-3800-4f48-bd76-30c2a7be554f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3ff67e0d-da3c-4107-8b58-fe7bc485eab8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fddb6b98-fb99-4db7-bd58-a0e1e41de8a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "83602d67-b0ee-4ffb-9367-1bd7f4e5e46c",
"db_currency_id": "87ba75e8-b14e-4cfa-935b-f47884acba95",
"db_language_id": "b10cbe10-855b-4168-ab78-7275d5c4e6c8",
"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-05-29T16:02:43.3688588+00:00"
},
"modified_dateutc": "2026-05-29T16:02:43.3688588+00:00"
},
"marketing_segment_id": "0e6efa3b-adc8-42f1-b5b6-09c68ef6470b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "79ef0fe1-0964-4ee4-97be-3c7d48d571ad",
"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": "4744c85d-9b59-4bc8-ac1e-adc0ad24dac3",
"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": "b6f1e7ec-c23a-4016-bcad-3523fda28ee0",
"db_country_code": "sample string 28",
"feelist_id": "ec504536-356c-4acc-9153-ffdd5964e32a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6738a97e-9acb-4ff9-a326-6972fe8c58cb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d60c5818-4f1c-4b26-8f18-af89b6269dad",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-29T16:02:43.3688588+00:00",
"db_currency_id": "e2618a6d-83f6-47ff-b799-005b180930fb",
"db_currency_code": "sample string 10"
},
"company_type_id": "6d002fe6-1b0b-4942-87fe-c1359f44c193",
"company_type_name": "sample string 32",
"company_type": {
"id": "586590f8-3aec-4e0b-a2db-d5ca80c77478",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0f21a179-15ec-4e7c-bf0b-b39d67fec7ed",
"sales_organization_code": "sample string 5"
},
"db_language_id": "04438f1f-0412-48d8-8b65-6f6885a008b4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "07515575-130a-4964-a281-9cc1375db8e2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e403df0f-3a1c-477b-aa9f-0bec3466cde2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b16d1e4b-ee1b-4ccd-b1ed-8aa2d4255baf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-29T16:02:43.3688588+00:00"
},
"company_sector_id": "fb951744-67c6-45ba-9f95-b4b7bd34d3c6",
"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": "269f32ad-d8be-4427-bd49-9fd3b3d4ddd2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "be5a9ee5-7f60-4cb0-aa97-6c8c7e9b7587",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "50d25be8-e607-4019-b670-63fc06770453",
"account_manager_user_code": "sample string 56",
"company_status_id": "6858b766-cbd1-4126-be4b-3ebbc4a510d1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-29T16:02:43.3688588+00:00",
"id2": 60
},
"db_language_id": "0102bd34-1cbe-42d5-9be6-89f8cf9809ed",
"db_language_code": "sample string 7",
"db_title_id": "6284225d-b074-4b1a-a3cc-89cd9a3fc5a9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-29T16:02:43.3688588+00:00",
"create_date": "2026-05-29T16:02:43.3688588+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-05-29T16:02:43.3688588+00:00"
},
"modified_dateutc": "2026-05-29T16:02:43.3688588+00:00",
"id2": 22
}