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": "a5b1008f-9cd5-450d-96e2-c1e3276d278c",
"_parent_id": "2e51ded8-3fbf-490f-bccf-514e84ac4489",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "e837767f-0616-4ef1-8ebf-46a22af10e3a",
"company_id": "0cbc6472-3f2b-4760-9c2a-3b9614db40db",
"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": "c90428af-04aa-43e2-8fdb-839d4a362f53",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "f297aca1-aece-43c9-97c8-03c67427a0df",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "7765a013-49c3-461c-aa75-cb6810401ae1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "17f8d75f-59c6-42ca-b5f8-a6c068b713ee",
"company_code": "sample string 5",
"company": {
"id": "df366b5b-fb2b-4cbf-9fd6-b03d998dba2d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-10T16:35:22.5251956+00:00",
"sales_territory_id": "352b3bf4-eb75-4f72-8101-177bacc519a7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d4f787a1-a49c-4f3d-a14a-04bbd0c0d66d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3acec86e-e60e-475e-a0a7-649431f7a746",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "50d2cd4a-8535-4698-a06e-68781ba72d39",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2967cd45-7858-4ad9-b751-ba7e6aeb8cbc",
"db_currency_id": "d4531168-9177-431d-b44c-3705cedc4fd8",
"db_language_id": "e8569ee0-0ff9-4010-9538-e78f42852bf7",
"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-08-10T16:35:22.5251956+00:00"
},
"modified_dateutc": "2026-08-10T16:35:22.5251956+00:00"
},
"marketing_segment_id": "c4ff16a0-7142-402a-abbb-be14c8af9520",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b91a9dcc-6aad-4023-9693-2a083bb283d1",
"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": "fa826333-7af3-4633-bf91-b8fa84a8852e",
"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": "462f3dec-a5ab-48db-8982-cf3a6e7a85d4",
"db_country_code": "sample string 28",
"feelist_id": "3d169abd-bb61-4402-8abe-36304cde9b9c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c5973fe2-4796-4585-ac06-45162243be6b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ecdde0bf-39ac-481f-87f2-dadb5d77d719",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-10T16:35:22.5251956+00:00",
"db_currency_id": "39360ae5-5a54-4817-a0b0-80b17570e28c",
"db_currency_code": "sample string 10"
},
"company_type_id": "f680f410-b539-4c4a-bafb-c08f5fac954c",
"company_type_name": "sample string 32",
"company_type": {
"id": "9403b8a2-7d89-4dd5-ad59-4da549b7dc25",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3b0cd827-772f-45f8-9927-45a07d5a086b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "58882157-9d5c-4d69-9243-9a4df664388f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "dfdc1377-d29b-4f43-8163-e29be2b4ff02",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "afba4866-8806-4f5a-86b3-e539dae8d80a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e2c77442-dace-4b2b-8c49-c430e15996fe",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-10T16:35:22.5251956+00:00"
},
"company_sector_id": "7141b891-6827-4b36-bbb2-8648360fc311",
"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": "14492ad6-d915-40da-bf94-36a57bdcd1b5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "eb20cfb3-92a3-4baf-8826-043d546e010d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "54d97e58-bcbe-4108-8ceb-134a53882037",
"account_manager_user_code": "sample string 56",
"company_status_id": "bc05a121-4df8-4b6a-953b-8ed005e09aec",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-10T16:35:22.5251956+00:00",
"id2": 60
},
"db_language_id": "a4ed3053-62f4-4d80-82c3-80d08cd8130f",
"db_language_code": "sample string 7",
"db_title_id": "a947e5a3-4ffc-439b-a254-428122389e9c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-10T16:35:22.5251956+00:00",
"create_date": "2026-08-10T16:35:22.5251956+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-08-10T16:35:22.5251956+00:00"
},
"modified_dateutc": "2026-08-10T16:35:22.5251956+00:00",
"id2": 22
}