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": "dd6659ac-ca58-41dc-8497-f0bee0f5f05e",
"_parent_id": "2b5a549f-4f08-4e00-a855-79f10ab90413",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "dacdb8aa-e6b2-4acf-b12d-b93fe6d52382",
"company_id": "a0f55062-46d1-407f-85d4-ea0730733bb7",
"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": "f81a8716-9b15-483a-adbc-3de835c5ef25",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "f1495075-41af-4ba5-88e7-77d432edfa9f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ef8efc3d-7c2c-4385-b014-3867faf204ff",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dbb87ebc-5834-4ef8-8b9e-62694ec27a1a",
"company_code": "sample string 5",
"company": {
"id": "2a54b6c1-6312-4a70-8540-709c90736286",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-20T17:53:50.9943348+00:00",
"sales_territory_id": "e8c2e7fc-7195-4427-91ae-9e87523064ea",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3baee099-5613-403e-ba7e-82760bf76517",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d527b10d-6cd0-47b6-9ee3-cadc894af5c4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f4f82637-f331-4677-affd-a4c758d9a7af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6cb1801f-d2ef-4928-9c27-d0bff19ab5ee",
"db_currency_id": "7988fcbe-90f8-48e2-a7c2-5c17c6791181",
"db_language_id": "fbd06b48-ffac-4575-a88a-32bc1883ad25",
"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-04-20T17:53:50.9943348+00:00"
},
"modified_dateutc": "2026-04-20T17:53:50.9943348+00:00"
},
"marketing_segment_id": "cc76c6bf-8859-46ba-a6b9-0604a5865215",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "44a78d8c-9005-40e5-a775-8f68fb52c6c0",
"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": "6ce808f1-4c4b-4b0a-8fd7-fd0e1bd7d44b",
"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": "0563ff12-7aed-40a6-b35f-35c17f5c0247",
"db_country_code": "sample string 28",
"feelist_id": "9a7eba92-ae6d-43ac-88f2-0f0c2a0533e3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7b4baebc-eda3-4ab5-8261-97bd653e9135",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "592643f6-75ff-4312-9a1a-0cb929eeed29",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-20T17:53:50.9943348+00:00",
"db_currency_id": "dc3185dd-2a60-4815-b564-56c978ecb1dd",
"db_currency_code": "sample string 10"
},
"company_type_id": "7f9c91a4-9678-4d7d-bc95-77010e2b63e6",
"company_type_name": "sample string 32",
"company_type": {
"id": "e51b630c-dd95-4842-8b89-89d01dc70b8b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "80b97469-336f-4a59-bed4-dd1a1ef66a1a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f0f5f7e2-9754-4590-b68d-b2200cc471b6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bc9ace3f-964c-490b-a7ec-0a09921b75de",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "99a33e46-f367-4a16-ac6f-65a51c68de4f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0431babb-5236-41b7-851e-ac60727dcc6a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-20T17:53:50.9943348+00:00"
},
"company_sector_id": "d5c1488f-933f-4d5d-b47b-f875e76a2cd7",
"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": "61ca7230-a32a-49c1-8ccc-528e494d006e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "74e5e6e8-afe9-460e-8bc7-9ca1afe558a0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2f0f4036-fa48-41d3-bdd3-3a4164977f57",
"account_manager_user_code": "sample string 56",
"company_status_id": "8cce617b-8dbf-4bfa-afff-285ecb5c5f87",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-20T17:53:50.9943348+00:00",
"id2": 60
},
"db_language_id": "27a073ca-8040-42f3-9258-4440fc00cab9",
"db_language_code": "sample string 7",
"db_title_id": "811f9346-4225-4e45-805b-67ad22534788",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-20T17:53:50.9943348+00:00",
"create_date": "2026-04-20T17:53:50.9943348+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-04-20T17:53:50.9943348+00:00"
},
"modified_dateutc": "2026-04-20T17:53:50.9943348+00:00",
"id2": 22
}