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": "a2d8fe1f-332c-45ae-9586-a6f2933090ba",
"_parent_id": "771af763-d3bc-4f9c-a68d-b3e2ded65946",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "96c71269-6f4b-4588-ba15-bb076dc4443d",
"company_id": "c849d260-c839-4c67-8520-a2f1db0f47cd",
"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": "ffff9f32-e770-4b8f-9dc9-1d82a400f9e5",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "0f08d541-5999-4e63-8631-1e64205af35e",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "a44e1e84-17f7-4d02-9635-e177284c9d4f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7254e0b3-0b4f-43d5-89fd-1b9b0246ba5a",
"company_code": "sample string 5",
"company": {
"id": "8060dcc6-4478-4cf1-9c48-9ff0f18f7721",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-20T06:38:57.4944702+00:00",
"sales_territory_id": "d2d1b194-5e15-4b55-9c6a-61d402dfab5c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f3b76790-1c33-4f4e-a56a-50363b88b557",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fdfa6129-71aa-4ebd-b1c4-e7ce0254d79f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1a339c55-0585-4ddb-b6bf-8c749bebd63e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "160c2cde-abba-41d6-9af6-e085924f16c8",
"db_currency_id": "47eae529-822b-48db-9b41-e8ac75602a6b",
"db_language_id": "8deaf49a-32e9-4f01-a01d-e1f13062d08f",
"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": "2025-12-20T06:38:57.4944702+00:00"
},
"modified_dateutc": "2025-12-20T06:38:57.4944702+00:00"
},
"marketing_segment_id": "8ab70997-32d9-484b-a032-d6ebc6d16d72",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c0103b9c-ed85-4873-9185-4cb04445ed46",
"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": "9620cfab-93b9-447d-bea1-8f074c1feac9",
"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": "2f00ad59-154e-41de-80e7-d3268aff1c6e",
"db_country_code": "sample string 28",
"feelist_id": "ce6df7ee-96b4-40b3-ba94-04c03db3a851",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "04ebd4f7-1a3f-4f7a-933a-0e3b54977d99",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "928671f9-4884-4cd6-ae9c-9ec77862f11d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-20T06:38:57.4944702+00:00",
"db_currency_id": "b507c226-d969-4265-b35f-fbe3d25603ad",
"db_currency_code": "sample string 10"
},
"company_type_id": "7f92449e-ffa4-4877-9fd6-8500ad7b2c23",
"company_type_name": "sample string 32",
"company_type": {
"id": "30ce2006-0497-485f-be0e-a7b505eba78f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cbcf4c7d-6d58-43ef-9aa1-8cec00b4c575",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2d622d47-8fc6-45fe-9a50-d5b7fdd2c314",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f789b8d3-6730-4798-962f-e3d52e539965",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e4044947-ad3f-4ac0-9e5a-b9edab6bed80",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "71d5dfb0-0bb6-4b32-b999-682871a1a070",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-20T06:38:57.4944702+00:00"
},
"company_sector_id": "c4aeaa41-0a42-4910-92cd-ae158acc01f4",
"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": "9e1c8fe8-c635-4233-9ec3-dfa850569e91",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5ad65382-4194-46b3-b24c-3c20904001fa",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bd93d16b-aadd-4a15-8cae-a83fbce4997a",
"account_manager_user_code": "sample string 56",
"company_status_id": "c545baf9-6481-4ba5-84ee-026b81ccf429",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-20T06:38:57.4944702+00:00",
"id2": 60
},
"db_language_id": "0508dad4-a324-413a-b6b9-3768a95e14a9",
"db_language_code": "sample string 7",
"db_title_id": "ede87243-a1f2-49f3-a03e-137499ecffa9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-20T06:38:57.4944702+00:00",
"create_date": "2025-12-20T06:38:57.4944702+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": "2025-12-20T06:38:57.4944702+00:00"
},
"modified_dateutc": "2025-12-20T06:38:57.4944702+00:00",
"id2": 22
}