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": "09bb9396-779e-4dfd-89fc-c2034758478d",
"_parent_id": "fe074a04-b126-415d-9d47-add6aded14c7",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "18c5d527-da6b-44c1-9b8e-1c4c35efcfc1",
"company_id": "d2d30e4f-6676-46a9-a1ea-02ce557f0d87",
"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": "50028a89-4126-4a62-9360-46d5ac6b3a65",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "7701e9ff-6e86-4203-865b-f8d2ed027486",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "c0166de4-085f-456c-bc4a-06b76812d1ff",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "12da09a3-d97f-4e89-86a9-e01debfe01ca",
"company_code": "sample string 5",
"company": {
"id": "27400dcb-1c31-4027-b938-75cd7cff10b0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-08T22:19:11.8281412+00:00",
"sales_territory_id": "1ade5429-a1f7-40a6-ba37-8639788ea4a6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bb039c92-4b6c-4e0a-9ea8-eac35e5b0e6c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4df86fac-96ea-4c90-91b0-954d3c8c8989",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8894f5ef-d387-46e3-a6f3-07b485104ebb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e08e593-5a42-4371-a7cb-74664ac18d41",
"db_currency_id": "16362f0e-2078-4e93-80fd-6e9317025661",
"db_language_id": "dd7e8645-597f-4246-b912-25fc7f5f500f",
"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-07-08T22:19:11.8281412+00:00"
},
"modified_dateutc": "2026-07-08T22:19:11.8281412+00:00"
},
"marketing_segment_id": "c1718929-facd-4703-92a9-dc0d7efcc5b0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "79e2cf51-6a40-4e49-8455-685478f157b9",
"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": "ae55aafb-7e1a-436c-8ce7-03904b83c685",
"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": "469f34ef-8019-45ee-924c-7ddad8d20aff",
"db_country_code": "sample string 28",
"feelist_id": "b1c02862-2823-42a6-afab-77ca5adcc657",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "df8ed1bf-ad71-48f4-b8b1-d817d172c526",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2c2f140c-481c-4b4d-9bc0-0317426a40bc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-08T22:19:11.8281412+00:00",
"db_currency_id": "287d6803-69c2-48c2-b5b2-ab94c1103c6b",
"db_currency_code": "sample string 10"
},
"company_type_id": "c5197d14-afac-4cb9-b2a2-bd034e6e74be",
"company_type_name": "sample string 32",
"company_type": {
"id": "88ab1a0f-a9f5-450b-87c2-9ea5043f5b96",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "87b01e7e-a5e7-4f02-9d8c-c59954c2bfe5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "259fed2f-e1d2-4633-b169-450fbafe239e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "dd75157e-5a05-4916-a500-bf718065e2f5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7cf7221c-e4d8-42ab-a95a-ce2478a381a8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a8aa9798-3111-4afa-becf-705591493878",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-08T22:19:11.8281412+00:00"
},
"company_sector_id": "a10369a8-76a8-4eab-ac66-e70dbf96ca2f",
"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": "ef94b75f-0535-4825-9e6d-dfd4192898d8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "665308c1-fcc5-4860-b9a7-fea463ccfe6a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "de5166fe-d3e0-4e85-8296-a058571d0187",
"account_manager_user_code": "sample string 56",
"company_status_id": "158e80e5-5f2f-4aac-9d73-4e52f0bd58ba",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-08T22:19:11.8281412+00:00",
"id2": 60
},
"db_language_id": "0fd19dc4-6a7c-4a8f-8ad6-26f9de3b5331",
"db_language_code": "sample string 7",
"db_title_id": "9d7583d5-0ca5-4b6e-b7d9-669d06f2bbe0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-08T22:19:11.8281412+00:00",
"create_date": "2026-07-08T22:19:11.8281412+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-07-08T22:19:11.8281412+00:00"
},
"modified_dateutc": "2026-07-08T22:19:11.8281412+00:00",
"id2": 22
}