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": "07ff60b3-8b37-437f-9619-288d51475baa",
"_parent_id": "1ba3fe04-1ec4-4ba9-861a-3dd0d5db1501",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9067ac76-6349-434a-a967-63dff80ec0ee",
"company_id": "396059ea-c4b3-456b-987f-2ca5ae64d386",
"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": "916f0b04-5c1f-40a4-bc19-fd66ab6e73f0",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "34ed0797-a4fb-4788-a1d3-e5c82d8015cc",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "4a4f1160-c986-4bda-aef4-5794467b17f0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f419f5ec-c8f9-493c-b50d-1526590e9e33",
"company_code": "sample string 5",
"company": {
"id": "60a654d6-a6bf-4448-9dfd-1da9a224a0ac",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-04T12:24:00.7322064+00:00",
"sales_territory_id": "ae2ba830-1ea9-42bf-8c0f-021b02afd563",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e9c9985d-eed7-4bac-9b48-d41ea4b66778",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "98aab016-6438-4331-a01b-20cfff215e82",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "db0cacea-5e6f-4b72-9b1e-8f6b0607fe4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c135ccf9-790e-40a1-be9b-2a2633940ac5",
"db_currency_id": "6ebe7927-4cb1-47a9-bdab-b409e0d93b1c",
"db_language_id": "25ad9b75-7959-4939-b328-123262f7ce8a",
"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-04T12:24:00.7322064+00:00"
},
"modified_dateutc": "2026-08-04T12:24:00.7322064+00:00"
},
"marketing_segment_id": "5b3c902a-5d9b-4dd7-bf69-4b8455e8dd6e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8e887c44-13b2-4694-890d-2682bd0629a3",
"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": "2742890e-4894-417c-bd35-d379480f398c",
"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": "b37441b3-407a-41f7-8a65-42fb8ccae2df",
"db_country_code": "sample string 28",
"feelist_id": "f49c407a-2672-4237-b01f-efaa93ebcb4c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ddd443fb-1df5-4050-a120-8e3229751ddb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6768ed70-91bc-43d9-b1b7-260a4e96cda2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-04T12:24:00.7322064+00:00",
"db_currency_id": "3f83e03e-9219-4652-b486-bbaca7738594",
"db_currency_code": "sample string 10"
},
"company_type_id": "a1d47d5c-f424-4f10-a0a5-ba559e32c7f7",
"company_type_name": "sample string 32",
"company_type": {
"id": "f0fc9647-5ab2-4ddb-b8d7-e04a14a9a169",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "21fd04d2-f944-4f00-8802-580aa3a0d0d0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "89c0d558-732c-4c19-b96f-68bdb146f854",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8a073024-dfdf-431c-9545-c77482820e69",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "220868de-85eb-4950-abf4-81e1025e6f46",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3dc84b7b-70f7-4f0a-941c-53b836d321ef",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-04T12:24:00.7322064+00:00"
},
"company_sector_id": "14a38556-5071-4e69-97a5-a9326f4bed04",
"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": "802640f5-32dd-4b90-97d0-cf83d415c310",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "155fb4f5-6526-424f-80e8-748a042bbe0c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3f41522a-7405-4547-89e7-40107515b9ee",
"account_manager_user_code": "sample string 56",
"company_status_id": "e2c104a0-5e03-42ca-95ee-d12e15e3964f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-04T12:24:00.7322064+00:00",
"id2": 60
},
"db_language_id": "e6e0dd3a-efd7-49d6-b2e0-8458c8ca53ac",
"db_language_code": "sample string 7",
"db_title_id": "803705ea-dd25-4b9d-85b0-ee561c253518",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-04T12:24:00.7322064+00:00",
"create_date": "2026-08-04T12:24:00.7322064+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-04T12:24:00.7322064+00:00"
},
"modified_dateutc": "2026-08-04T12:24:00.7322064+00:00",
"id2": 22
}