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": "6bf071af-28c3-48ec-9ddb-8074e6ebecac",
"_parent_id": "501d5018-7c3d-4725-8e24-da04dc8e6b5a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "11e32597-8878-4cff-821a-fcde5440d287",
"company_id": "4c1d283c-513f-4dea-b826-3b6c856ff6bf",
"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": "9850a66b-92a0-4272-912b-70ba4d4a0a1b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "2366dab5-657b-44b1-89a0-0a4186cef77a",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "cc506ccc-b20d-412d-812f-4849fbc5bbe0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "aab11e84-9fe6-40d5-b8e6-7e007080e5ea",
"company_code": "sample string 5",
"company": {
"id": "77d0b602-194b-4bf6-ab2c-2351f611d758",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-15T19:29:07.1087267+00:00",
"sales_territory_id": "0db12c13-3a2d-4822-aec7-020abfde783d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7dd10d6a-4de4-4c4d-b7d3-110d2763f97b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "889bd0cd-dbdc-43db-b4b0-db54d8a6ca3d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0cda17f0-0097-4a41-8f5b-e5909ba74061",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e86409e8-3eed-4dcc-a68f-152a6f1d59a2",
"db_currency_id": "efc30da1-585b-4e71-8d96-0ae80b99eda4",
"db_language_id": "3eb060f9-158d-4aaa-8d87-4004e936b5c4",
"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": "2025-10-15T19:29:07.1087267+00:00"
},
"modified_dateutc": "2025-10-15T19:29:07.1087267+00:00"
},
"marketing_segment_id": "625a8fee-ff3d-40c5-81a1-342bf2f3bc2f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4f627812-9519-4f47-a76f-f5d8d9f7fe66",
"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": "433c396d-0bc2-416f-b507-1515e01b730b",
"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": "e1a897b6-62d3-4a0c-886b-7f9af155c4ba",
"db_country_code": "sample string 28",
"feelist_id": "ff5ee846-ca2e-415c-a350-dca021c48712",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "14d99587-997f-4c0c-9041-f99ab216908a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7fad9020-98e4-451e-bf72-919d8a900129",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-15T19:29:07.1087267+00:00",
"db_currency_id": "b360cba5-698f-4d3a-a550-46dbbcce3e7b",
"db_currency_code": "sample string 10"
},
"company_type_id": "0c66c3ce-d41f-4f53-a9fe-4f394b665c15",
"company_type_name": "sample string 32",
"company_type": {
"id": "172b2a0c-52c1-4102-ad46-719335d217a5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "05a46107-a2fe-477f-9a5d-c80791acdc4c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2a18cfcd-25be-40ef-8b21-ece140bc0684",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d3abb681-f910-4330-b354-f29ec13aa81e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "bdbe3431-f3a0-415e-92f0-683cd944efdd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bed00355-a55b-454c-893b-ffdb9e7806cf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-15T19:29:07.1087267+00:00"
},
"company_sector_id": "1dc42b9e-1b28-44de-b7ff-e9033f1dd6a9",
"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": "4161df21-bcdf-4847-8947-6647ddb871dd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b1cf8c5f-6439-49d8-958f-91da74511b94",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "614be26a-ec0a-4e78-8a1c-f91abc43f44d",
"account_manager_user_code": "sample string 56",
"company_status_id": "660186c1-ec36-4b7a-96aa-0d7bb1d51dcb",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-15T19:29:07.1087267+00:00",
"id2": 60
},
"db_language_id": "c7804719-fb59-462f-978c-79e2967d53e0",
"db_language_code": "sample string 7",
"db_title_id": "a32f6be6-5274-4224-bf34-f25efaa305ad",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-15T19:29:07.1087267+00:00",
"create_date": "2025-10-15T19:29:07.1087267+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": "2025-10-15T19:29:07.1087267+00:00"
},
"modified_dateutc": "2025-10-15T19:29:07.1087267+00:00",
"id2": 22
}