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": "ad796dbf-8f9a-45b8-926b-930fe830e173",
"_parent_id": "e661c24b-513f-4f50-b2b5-8fb9779f4324",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b8445799-9c90-4c99-bcbe-f6d0bbe76fb8",
"company_id": "1f3d4f21-c69a-4606-98fa-d9f9b88c3976",
"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": "3b2e679e-cebd-499c-b8f0-0d7350137101",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "6a6082a7-52d0-45f5-ba08-947009dd8273",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "aa5a36dd-366a-4241-bff1-690a96e94dc7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "aa447e1c-038e-482d-bb5c-ad1442b18459",
"company_code": "sample string 5",
"company": {
"id": "6d6996f1-1ad0-46aa-9d17-600d824d22ff",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-14T07:09:02.0857914+00:00",
"sales_territory_id": "1de21c68-6cfe-46f3-adc6-aba8d4d79b2f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6235077a-9b10-4bc3-b8eb-df71b3be92a0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2ea25bf4-2807-4fad-9151-44f4068d6289",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "361c46da-6c74-4894-b132-06ec4c7ffe95",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bdff0fa0-4856-41bb-ab35-8c77532eb766",
"db_currency_id": "e082b580-63ff-424a-bd9d-95ae8ff88366",
"db_language_id": "316aa1d3-4b77-404d-aee8-b3b29373da61",
"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-10-14T07:09:02.0857914+00:00"
},
"modified_dateutc": "2026-10-14T07:09:02.0857914+00:00"
},
"marketing_segment_id": "0610b3f1-0c1b-46bf-a929-6d3b226c8c36",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "57ea1f36-ce74-4277-9574-f19880471ae7",
"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": "e2897414-fe89-415e-8f07-6ceb2dc7ece9",
"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": "63eb3dae-3fe7-472f-8695-d9406652567d",
"db_country_code": "sample string 28",
"feelist_id": "8a545af8-db2a-4892-acee-f1760dbe69c6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cc8e9c58-e143-4cf2-92ef-2460394d8ec4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "62c72eb3-d95c-4849-bf1f-89f0cad516de",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-14T07:09:02.0857914+00:00",
"db_currency_id": "ccf6327a-370d-42cf-b39d-dec02a40f65d",
"db_currency_code": "sample string 10"
},
"company_type_id": "cb4df0e2-1e98-4395-aaa0-3432bfbebe21",
"company_type_name": "sample string 32",
"company_type": {
"id": "08ababd2-fa39-4166-94da-d388d2bd38cc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "61cf32e6-db67-4e53-82c4-65a1326d4ada",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fb0106c8-be6b-4926-8de2-78d259d44976",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "324adb68-b126-44d7-b02c-447eac9133d0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e2a87435-6328-4f35-8066-09f53f811373",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c14c669e-3cd6-4123-a309-d62050f5097d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-14T07:09:02.1056629+00:00"
},
"company_sector_id": "c1722635-447e-484e-a42c-ca88b4d087d3",
"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": "73720a3d-dacf-4bd1-a9f8-e1ff744aaeba",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "84c92fcc-8de2-4476-8fad-a9feea41640a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "330e6766-f551-405f-bd81-9d858c121f49",
"account_manager_user_code": "sample string 56",
"company_status_id": "505028fe-fcc1-4a46-8b8a-2d46a364bdea",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-14T07:09:02.1056629+00:00",
"id2": 60
},
"db_language_id": "812a747c-e201-4800-983c-ba0232dd7182",
"db_language_code": "sample string 7",
"db_title_id": "8087ff59-a0be-4791-a0b5-68ae07bf05e0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-14T07:09:02.1056629+00:00",
"create_date": "2026-10-14T07:09:02.1056629+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-10-14T07:09:02.1056629+00:00"
},
"modified_dateutc": "2026-10-14T07:09:02.1056629+00:00",
"id2": 22
}