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": "5967ec0e-f0d3-4fa6-859d-33df8ec2635e",
"_parent_id": "16c02afe-9fb4-446b-b77c-cf8d0ec15858",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "d3251090-bca1-4d2a-9b24-33bfcc6e45ec",
"company_id": "4ef3de48-abfe-47bf-b159-62fac611804a",
"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": "81c6ba76-1839-4f38-b9dd-87e79617a490",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ea52f2f0-69bc-4db2-b8ac-7be27fa6b867",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "0c7d59b5-a614-4a38-9a8e-d43f877753b7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "aa88f27f-2d4d-44ee-85bf-ae3ecff8a430",
"company_code": "sample string 5",
"company": {
"id": "8c55a034-de5f-4c7b-b658-725ccaf9b82d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-30T10:45:00.9556274+00:00",
"sales_territory_id": "d1f85249-e8c3-43c1-a50b-69fac3c6c2d4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7aa168bb-e685-48b3-8d52-37754876eff1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "42b6e1a4-cb65-475b-82ca-4eba1c9ee6cd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "850f707c-8e76-4b13-b00e-0a547fe4a981",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78b7766b-4c73-40d3-9d7c-6406b43463f4",
"db_currency_id": "226eed84-a2a4-4c98-889c-03462e7b97ba",
"db_language_id": "b6bf5a69-f569-4c80-ae82-809b24d2aa05",
"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-05-30T10:45:00.9556274+00:00"
},
"modified_dateutc": "2026-05-30T10:45:00.9556274+00:00"
},
"marketing_segment_id": "ef13b26d-1b07-4751-bc61-7b96e1fdc333",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4cd297ad-3987-46be-b697-20751614455f",
"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": "a6fafff0-da4c-4dd1-b8b9-2bff5f01ea42",
"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": "6f70eef6-16ed-4f8b-97fd-3f0207fdbcca",
"db_country_code": "sample string 28",
"feelist_id": "ec8d3d22-5cde-4b47-8c17-292b11e4adf9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "13f59e6f-6745-4f9f-8fde-09250f2b0414",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a936164d-ab55-48a6-8f7e-11a232e02f59",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-30T10:45:00.9556274+00:00",
"db_currency_id": "cfb2b9c5-83d9-4f61-a05d-9388a835d811",
"db_currency_code": "sample string 10"
},
"company_type_id": "c32f3b0b-b601-4f87-900e-f564ed97a891",
"company_type_name": "sample string 32",
"company_type": {
"id": "392e3409-dcbe-497f-bbd6-1e2a767b484e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9dbd6af5-9ea2-4a88-ae2f-a7d9c99a5c59",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ea985437-0c5c-44d1-8eb0-60392050d9a9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "aa1dadec-e317-477d-9793-b1f120fa2ee5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a0c3a59a-7561-413e-9942-435560752e50",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f1ec6caa-46f3-46a1-81aa-6d38273a3bc0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-30T10:45:00.9556274+00:00"
},
"company_sector_id": "3feda99a-fbbc-41d6-875c-f933df5bfd4a",
"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": "de04963f-7998-411c-85f5-f424979150a3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0dc82d02-32d9-4b63-ae51-5dc0c20fb177",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b3d2deaa-6c70-4c78-805b-b25dbfc08800",
"account_manager_user_code": "sample string 56",
"company_status_id": "1f759277-cbb2-4093-a3ad-818ffe435436",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-30T10:45:00.9556274+00:00",
"id2": 60
},
"db_language_id": "718d95af-4f9c-4b7c-9147-9703c8202050",
"db_language_code": "sample string 7",
"db_title_id": "4bb196a0-d88c-4934-b00d-30bcbf6a478d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-30T10:45:00.9556274+00:00",
"create_date": "2026-05-30T10:45:00.9556274+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-05-30T10:45:00.9556274+00:00"
},
"modified_dateutc": "2026-05-30T10:45:00.9556274+00:00",
"id2": 22
}