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": "03066515-47a1-4a04-93d1-6180e4b3aebb",
"_parent_id": "1679d296-e515-497a-a0bc-900fc7dc87e8",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "a5eea6cb-30dc-41ed-980e-a804f1e8fc72",
"company_id": "772afd26-d4cb-49f3-8419-5fef5b1356fd",
"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": "62b82848-2ac1-4ec2-a655-2ddb1baec26f",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "e11c1c9a-66ab-4c21-81ff-f5e6f3806e84",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "43b94ef4-58cb-4995-b6d1-c739510e948b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3be012ce-11b4-44d6-859e-dbdf70dddb66",
"company_code": "sample string 5",
"company": {
"id": "8bfd1a5b-8759-4e3f-99ab-84759d0f4fa3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-11T09:55:22.8855166+00:00",
"sales_territory_id": "309fbfcf-c043-4f0c-92d4-eeb989d50b11",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8f964c15-bcc7-4764-b1a8-66a58226ac47",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "37c7792e-7ff5-424e-a968-ada5d94a19d3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b606219f-9904-43b9-b4f9-a1e1f8ebd7ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dee2c0e8-edb2-4864-950a-c820d5e8feb0",
"db_currency_id": "1c6938ed-c492-4757-b3b8-a26bcfa56bd1",
"db_language_id": "26dc2c46-639b-4045-baf1-794b921972b4",
"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-01-11T09:55:22.8855166+00:00"
},
"modified_dateutc": "2026-01-11T09:55:22.8855166+00:00"
},
"marketing_segment_id": "6aa67dd9-aa41-47be-bde2-84382b27f515",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "476509c1-46a4-450a-8d09-5e4e17deddcf",
"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": "c20f8df2-5bef-490d-8063-986f0e77f294",
"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": "a2b4c9a8-947e-4c9c-9c1c-fffe7ef678e6",
"db_country_code": "sample string 28",
"feelist_id": "3b8e201d-8547-41aa-a2ee-cd52dfe07c74",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8404cd41-224c-4f2e-989f-b9bd713dc198",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b15140c9-7978-4a49-af4d-a2f1e3642b13",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-11T09:55:22.8855166+00:00",
"db_currency_id": "652f4844-fb79-41e9-bc7f-812c09635fba",
"db_currency_code": "sample string 10"
},
"company_type_id": "6aacfa41-c8bd-4fb5-91bc-3f3bd77a8669",
"company_type_name": "sample string 32",
"company_type": {
"id": "95af009b-8b21-4ee1-9ffa-caa5baad6ef3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3947c1f8-378f-4abe-9574-5ffe4047bb37",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c61275b9-5135-4ff4-9033-f64e4edf117e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "33491104-1265-4164-a07d-0b68d4c5fcb1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bfa6f81c-89d6-4f6e-b8a0-ee7e9e7cdf40",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5e5118f5-16d1-4aad-b6e4-1d288bf59aea",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-11T09:55:22.8855166+00:00"
},
"company_sector_id": "9e6f308b-f153-41a0-bc8a-06b4768485f7",
"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": "7b6bec51-abb6-4ca9-b6e3-31900576e420",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4025f369-c580-46db-b0c2-c5b3dc4f0a5a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9756eba5-f4b5-4fb9-82bc-75f858475752",
"account_manager_user_code": "sample string 56",
"company_status_id": "c434b491-ec0a-4e83-8adb-fad3545dcd72",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-11T09:55:22.8855166+00:00",
"id2": 60
},
"db_language_id": "12691a8a-ea36-4724-8028-2428fa4d0eec",
"db_language_code": "sample string 7",
"db_title_id": "b1ecb8df-8a15-4088-b286-bf9c8839ae09",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-11T09:55:22.8855166+00:00",
"create_date": "2026-01-11T09:55:22.8855166+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-01-11T09:55:22.8855166+00:00"
},
"modified_dateutc": "2026-01-11T09:55:22.8855166+00:00",
"id2": 22
}