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": "7d7bc6ef-f58a-4475-8735-da184bb1a8e8",
"_parent_id": "b4823466-2805-4540-8ab7-f0af0aa70713",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "f800bbbd-38f6-4617-85e1-79134c6d01eb",
"company_id": "29ad7cd0-cd0a-4606-a839-62428b2ca458",
"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": "812837ae-4cf4-4302-bfd3-4c137c01e178",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "cace0473-5223-43f6-9fbf-e858fc6c9dda",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "2fe6b5cc-10a3-4415-a60d-733cc8947329",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2c2bdea1-6bfa-4e0b-87ce-3d7b5a801692",
"company_code": "sample string 5",
"company": {
"id": "31dd4672-cc4a-4352-bc2a-eafcf1f77626",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-06T21:00:50.5287132+00:00",
"sales_territory_id": "a0969229-fc63-4c9f-b837-82cffb0ea763",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "48100068-b6b9-4396-a589-7619cee58b2b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "08bc7c20-8c20-4ecc-a202-a0a6c6186919",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b5736e6b-5cad-400a-b873-af70dc564734",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4e275cd9-bc09-436e-8668-e15cde419456",
"db_currency_id": "29a305b2-8170-4264-8ae6-99c725908608",
"db_language_id": "3883db0a-622a-4703-abfd-0b0cd03e29eb",
"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-06T21:00:50.5287132+00:00"
},
"modified_dateutc": "2026-06-06T21:00:50.5287132+00:00"
},
"marketing_segment_id": "84e82d78-dbf5-4d1f-9c9b-f8e1b679e81b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5e1d3855-f23f-4d76-9c51-de0b1ebbfb92",
"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": "1ef1f33d-c5cc-465d-8002-0d2590cf9905",
"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": "519b41ac-7d95-4982-8a2b-b469009356d1",
"db_country_code": "sample string 28",
"feelist_id": "6549dfdf-5ed7-495c-b0ba-3480a6604ff8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5af620c4-59c6-483a-812f-f99ac5e90142",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "19411d93-8a7b-4f51-9ce7-bb5d2cfc6593",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-06T21:00:50.5287132+00:00",
"db_currency_id": "5cb89e53-444d-44e4-a2ad-29e0cbdbf40d",
"db_currency_code": "sample string 10"
},
"company_type_id": "5796c861-03c4-45c8-b276-f02c3775e911",
"company_type_name": "sample string 32",
"company_type": {
"id": "97dd34d5-5373-43a0-b58b-cc23e8517a80",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "de6ecf08-2098-407f-b01e-325aeb2c9aad",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b5339eb5-9dfb-48fb-8408-ae8ccf91d4be",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3b9b1dbf-2853-4002-98d9-51031337837a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "562fe3c4-bed9-4c22-b406-5992ea8b7196",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c02001c6-69e8-4a93-8dd9-5f3fbae472d5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-06T21:00:50.5287132+00:00"
},
"company_sector_id": "6fe7c666-068b-4952-b51f-b79851554ac1",
"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": "4aad1ec3-2843-40fe-9614-aa4c92a53896",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "30ef9dae-7b5c-4fa3-a1df-43899d09fe1f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "cc93b587-66f3-412e-87c4-a52156391638",
"account_manager_user_code": "sample string 56",
"company_status_id": "799d4b72-cb6d-45ff-a285-692325aa0ca7",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-06T21:00:50.5287132+00:00",
"id2": 60
},
"db_language_id": "30306193-7eaa-4aa1-9109-514349e195d0",
"db_language_code": "sample string 7",
"db_title_id": "62b79c94-37f7-484d-a024-385b559e9167",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-06T21:00:50.5287132+00:00",
"create_date": "2026-06-06T21:00:50.5287132+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-06T21:00:50.5287132+00:00"
},
"modified_dateutc": "2026-06-06T21:00:50.5287132+00:00",
"id2": 22
}