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": "ad9b66aa-43b7-4aba-8d41-a9c678e7a30c",
"_parent_id": "cb6cd765-e5da-4d95-9d65-772c6986340a",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9a5c9fa2-5fb9-468c-ad36-a546e3f8fb2e",
"company_id": "3ce14c2a-5b3f-4a7c-8464-16074acd5711",
"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": "d93a1041-c055-4fa7-974f-ab4cc7b337d9",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "ef7992c2-c744-4f05-b67c-673eb559ace9",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e87deaf5-64f7-4be2-be89-92debe912df4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1bbc0f3c-61a1-4439-aae1-c4a20e8571f0",
"company_code": "sample string 5",
"company": {
"id": "78159378-2ebd-4b71-b991-afdf549ceb26",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-17T08:46:35.9343366+00:00",
"sales_territory_id": "d6cbccdd-d475-41b4-b6e2-b95d1778e9c1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "dd388bb2-c6ce-47a6-8fa2-b76826d13acf",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "19d972b8-98c6-488b-b8c9-67fbd0142c32",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "90e41b1e-4a96-4c8a-a2d4-54d2ae12ea92",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a73bb710-ce65-4473-912c-92c49447d9f4",
"db_currency_id": "7e8c62d6-6a60-4561-9bd7-38e963e43047",
"db_language_id": "89fb360f-2359-4e52-9f63-18f0ce2ba1d1",
"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-07-17T08:46:35.9343366+00:00"
},
"modified_dateutc": "2026-07-17T08:46:35.9343366+00:00"
},
"marketing_segment_id": "5e6e9099-082c-47f9-9318-debdcafbfc8c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "64b1b7f5-c10b-4c9b-aefa-2b448c1a729a",
"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": "ccf202a2-4607-4803-ab7f-f4426e59316d",
"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": "f0fcba1d-1c96-4688-9a6f-00db493b5457",
"db_country_code": "sample string 28",
"feelist_id": "11f84640-b7d2-4df4-9843-b9222ea333f1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "26c6727a-fbe4-4313-a88c-41e527a289a5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1cf4c6ba-0b7b-466f-a242-c36989bddbe8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-17T08:46:35.9343366+00:00",
"db_currency_id": "d17dbf55-fea2-4c73-af97-251fcc27a7eb",
"db_currency_code": "sample string 10"
},
"company_type_id": "b5d9a934-51e1-4743-a881-a1c38a3d3ce5",
"company_type_name": "sample string 32",
"company_type": {
"id": "14a6e76b-891b-4726-bb2e-e43fe42827bd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "95bfedc5-924a-4d38-b18b-8692d583659d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ceee5b9d-70c8-44c1-8016-d6e5c9583b97",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a9d6add4-89a5-43a1-9fff-141651a664e5",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cd6cddea-f6fb-46ac-9cf8-0f57cca64229",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "dab3e8f9-ddb5-4404-afbb-87d37430ad44",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-17T08:46:35.9343366+00:00"
},
"company_sector_id": "004f9505-4e72-4551-b696-37168c71452d",
"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": "2ab7f482-7c39-4dd8-aafc-4d7929784208",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a71e925e-a1f3-4ae5-a965-daaba28d10b1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4645db49-fc23-4f38-89f0-33082d1d5e66",
"account_manager_user_code": "sample string 56",
"company_status_id": "dca997f0-7966-4da4-854d-90f0039a4df3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-17T08:46:35.9343366+00:00",
"id2": 60
},
"db_language_id": "0cc2ee8b-536b-41e9-9120-d6954a06e555",
"db_language_code": "sample string 7",
"db_title_id": "e3bd519b-6481-4023-85b1-4eca40a8a296",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-17T08:46:35.9343366+00:00",
"create_date": "2026-07-17T08:46:35.9343366+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-07-17T08:46:35.9343366+00:00"
},
"modified_dateutc": "2026-07-17T08:46:35.9343366+00:00",
"id2": 22
}