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": "739ebb53-1168-44cf-943c-eccf2fc61a2f",
"_parent_id": "732dfea0-55df-456b-b057-d39527f4ba5e",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b5ac4f67-d2dc-417e-ba72-99a2b2d5b4dd",
"company_id": "4ba379b8-c642-4884-ac99-9cb78c1a464f",
"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": "283744e6-888b-49e1-b896-ddcbc361ac41",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "eea1a253-9f47-40b0-93a6-153b42f22ee1",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ed4d94e5-2e42-43e6-8ebc-e47f759e26a5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5fc4265a-22dd-4a8a-a82f-5b7f77e461f2",
"company_code": "sample string 5",
"company": {
"id": "f97ec566-e379-4774-bb81-ff1481a45ebb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-10T22:30:31.4719736+00:00",
"sales_territory_id": "53df8f20-3e4e-4613-b8cc-6c37f9ce9a33",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b5037dbd-16b9-4919-9fbf-e64f436818e9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ead24f8c-b02a-447d-985b-602c08715c15",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9f74904f-f8b6-42e8-a478-4db62bf403fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d6375a4-151b-43f7-bd9c-ad17c2f43270",
"db_currency_id": "cd64b56b-a315-4986-a0f3-744c71889340",
"db_language_id": "02643636-907a-4357-a0bb-b0be329172f7",
"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-12-10T22:30:31.4719736+00:00"
},
"modified_dateutc": "2025-12-10T22:30:31.4719736+00:00"
},
"marketing_segment_id": "f1589e9a-6fad-47a6-aa70-1637363b387f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "979638a0-6b47-46e2-9631-514e3c743f7e",
"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": "6beab0da-9e05-424e-9ccd-2e2633df00e8",
"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": "ba63d847-18e0-41c8-babf-34e5486e2a2f",
"db_country_code": "sample string 28",
"feelist_id": "c7ef5b07-4607-4434-ab3d-500a0f530841",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e0a64770-8072-40bd-8422-6e23a39f91fc",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bce38d5d-240f-4aa7-8a18-5be3d3e5dffc",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-10T22:30:31.4719736+00:00",
"db_currency_id": "6c01816e-95c0-42c1-8b24-90b3ae8b9a22",
"db_currency_code": "sample string 10"
},
"company_type_id": "bd4b1e84-2877-4172-95b1-d6a62cebe1a0",
"company_type_name": "sample string 32",
"company_type": {
"id": "0ef8a337-e46a-4f49-ad69-fe75ee4ed736",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2df4ad06-d2c9-449d-9ddb-9e30c4f9bec0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "55b4fbd5-1d8f-4e62-9c72-9ad23ee0c152",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "640b5fae-8dfe-4887-af83-d66ebb7db8f2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5bf433e1-4ed7-4ac8-aa55-1e80ab241baa",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c9f2abc8-761d-4aa1-b3aa-e8e08bf1ecec",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-10T22:30:31.4719736+00:00"
},
"company_sector_id": "ae30682f-c15a-4724-a67a-d4dfc2af1e39",
"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": "2cdc9f92-6ec1-4dce-9bf5-5f5cb4464bb2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f846036f-ba8a-411d-9f5b-4ecc829ac884",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bf39e485-ce64-4fb2-adbc-259d98efb4a0",
"account_manager_user_code": "sample string 56",
"company_status_id": "73cbe1c6-064a-4efa-9986-db13966c0972",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-10T22:30:31.4719736+00:00",
"id2": 60
},
"db_language_id": "f6176289-f2fd-41dd-a9a4-6c7f1516cc5d",
"db_language_code": "sample string 7",
"db_title_id": "1ca697eb-ef3d-4364-80dd-89bd5c298df3",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-10T22:30:31.4719736+00:00",
"create_date": "2025-12-10T22:30:31.4719736+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-12-10T22:30:31.4719736+00:00"
},
"modified_dateutc": "2025-12-10T22:30:31.4719736+00:00",
"id2": 22
}