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": "8777486b-b0e3-42c2-9704-506a3d830332",
"_parent_id": "beb6f5e5-38a2-48ca-8bb0-10e69a9d8df2",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "570226d0-cb40-415b-b1ab-cf67857fd2d7",
"company_id": "8f776684-c5ec-4e04-9738-c5bb53ad06fc",
"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": "b2dd5e36-a93d-42ed-8364-58b93c13ae8f",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "f1437d98-94d0-4639-8173-cb6e7239b45e",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "dc8f6a0f-67be-4b01-89fd-6e220ad5ac84",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "38af106f-da37-438f-83d8-8fff3979f35c",
"company_code": "sample string 5",
"company": {
"id": "d88484f0-5808-4d04-8fa3-dfcb1ebe764d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-13T23:50:19.5866559+00:00",
"sales_territory_id": "edaa6092-a925-4712-ab2a-85619b5e4957",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "91757ac5-52e7-4c95-ac56-6919a0bbda1d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3ac53e2f-5eba-4167-aa68-3f2293c70209",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1cb4111f-b5f8-4608-9000-87e0b160b6d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24479503-d333-4790-8d2b-ecf53b0842c3",
"db_currency_id": "fe2193da-d585-4d34-bf40-b835a6e1ac6c",
"db_language_id": "dca25006-1d46-4223-b381-4c1cc99153d6",
"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-06-13T23:50:19.5866559+00:00"
},
"modified_dateutc": "2026-06-13T23:50:19.5866559+00:00"
},
"marketing_segment_id": "d5022eab-039a-4917-9af9-b9c9c1347dda",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "768af30f-70d2-461f-bdcb-41107ae215d0",
"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": "231addaf-14d8-494a-975d-ad7c37287e45",
"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": "47146bf2-badc-4625-8608-e2ccbb1f3dd3",
"db_country_code": "sample string 28",
"feelist_id": "bad6e739-2dd1-4b45-9141-8848161da811",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f67634b7-414d-4d6a-ad46-a99b3871ca79",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ab6a1b7c-67b9-4c5a-a005-492099faab11",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-13T23:50:19.5866559+00:00",
"db_currency_id": "92e1202d-704f-4911-9b7e-2e08401a68b2",
"db_currency_code": "sample string 10"
},
"company_type_id": "d1f2c481-078b-410a-ae5f-f7168ca8b6d1",
"company_type_name": "sample string 32",
"company_type": {
"id": "d47c9f43-d03f-47d9-88b4-eedd9d056418",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "987ddc53-4352-4734-9c48-f13f60a971fa",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b5fd06fa-2a3c-4292-bf20-ab9726fdb903",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0a1ca02d-99ac-44e6-bd7f-bfff7ce35aca",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a1cce291-c3f8-4f13-9d00-caa975067dc8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a4b1de73-34bb-4a8f-85e8-5ac7773fbc1d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-13T23:50:19.5866559+00:00"
},
"company_sector_id": "78d9f1ab-c75b-452a-8d83-4b563d2555dc",
"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": "4756ca28-9b45-48ec-bfdb-26e12752054c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1ea834b6-17f3-4efb-9e57-56f4b99407b2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c4268962-a300-4c61-9527-1cb0eab8859e",
"account_manager_user_code": "sample string 56",
"company_status_id": "70b32884-c1f3-46d7-b3cc-d5a54a05cdb9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-13T23:50:19.5866559+00:00",
"id2": 60
},
"db_language_id": "38d2263e-f3ac-45bd-a744-a409c6df19a1",
"db_language_code": "sample string 7",
"db_title_id": "06516cc0-a5b0-4294-984b-6ec7c41f7878",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-13T23:50:19.5866559+00:00",
"create_date": "2026-06-13T23:50:19.5866559+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-06-13T23:50:19.5866559+00:00"
},
"modified_dateutc": "2026-06-13T23:50:19.5866559+00:00",
"id2": 22
}