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": "256602f1-7c04-47e7-9855-5fd373fa1686",
"_parent_id": "e500ea5f-d3ce-4204-8686-df66e0698aa1",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "58368ccb-ec84-4cff-a42a-a1885de90e34",
"company_id": "49016105-4910-41ee-b205-48795c50b4ea",
"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": "d4ded4ad-36e6-4c5a-b0f1-44c1a545b964",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "77c73064-6178-4ef1-8b78-966172febfa2",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "42fe1d59-ef4f-4ace-ae36-7ae29e464bc6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f8ac10a1-8438-4c7a-9339-f917dd932d80",
"company_code": "sample string 5",
"company": {
"id": "d2bde07b-428d-470a-8ccf-5243f0a0aaff",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-15T23:07:03.194093+00:00",
"sales_territory_id": "b59e0f25-49b5-4e57-bb81-5a8049a35298",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "af43375d-4bfb-49fb-a319-2df3aab484c7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1199294a-4d84-408a-a51e-8cb853f3389b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fbacd21a-1716-4530-8edc-f9529bbc34b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ccfb1f06-65fb-46ce-8714-200429e0c660",
"db_currency_id": "38bec75a-4e59-4f9a-a416-4a4bb0b64d7e",
"db_language_id": "7b5110ef-cddc-408c-80ad-609aba2352e2",
"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-07-15T23:07:03.194093+00:00"
},
"modified_dateutc": "2026-07-15T23:07:03.194093+00:00"
},
"marketing_segment_id": "6b64d388-ecf0-4d9b-9566-f2508215a26c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "25db92c5-fe9a-403b-b6b7-28b82bd69378",
"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": "bca6b156-ed19-4239-a0a2-7025059ead5d",
"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": "e00938e7-e07f-40d6-b5d6-5d7d8d78acc8",
"db_country_code": "sample string 28",
"feelist_id": "636e1566-550c-4fbf-8824-4e6a4a29b048",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ba09d396-0283-4dc8-9c34-2329e4d38a2f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1bd04330-2010-4a6e-828c-3e7fba14c8cf",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-15T23:07:03.194093+00:00",
"db_currency_id": "8640cd55-9596-41b6-bef7-8e50f85ea2af",
"db_currency_code": "sample string 10"
},
"company_type_id": "877d1eaa-4e9e-43a1-9559-860476e911d5",
"company_type_name": "sample string 32",
"company_type": {
"id": "4fc3ad12-0c56-41df-9314-5790d1bdccac",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "72fffb35-54f9-4956-883c-970e88e24586",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6307e763-617c-480c-a8f2-3b6e02cfe326",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f27b4000-3fcd-410f-bc59-d88084fc5213",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4b9b4fd6-b473-4e0f-908e-c462961dfad8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8fdc3c77-4c35-4af3-99d7-18900c49e2c7",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-15T23:07:03.194093+00:00"
},
"company_sector_id": "b02ce24d-fe85-49c7-ba3a-34116258858c",
"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": "ee0428a4-2acc-40c8-9648-6d0c5aa6de02",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "911fdd48-a7f7-4371-b265-5e6377c02fa8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "51b6e54d-3a75-4582-baa7-fdd7dc8e6063",
"account_manager_user_code": "sample string 56",
"company_status_id": "beb0e700-0c67-4aa0-bc72-301c34e6d1fc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-15T23:07:03.194093+00:00",
"id2": 60
},
"db_language_id": "dc88f308-b2d1-4e36-a0a0-dd61806c4aef",
"db_language_code": "sample string 7",
"db_title_id": "3998ebc3-2af8-409b-8167-e8635c619841",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-15T23:07:03.194093+00:00",
"create_date": "2026-07-15T23:07:03.194093+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-07-15T23:07:03.194093+00:00"
},
"modified_dateutc": "2026-07-15T23:07:03.194093+00:00",
"id2": 22
}