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": "0223631d-191b-4386-ba6d-f4a785349607",
"_parent_id": "6f09f569-5503-4f04-96dd-45e18d1a669c",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2bbe35e9-0e95-442c-a3e9-83773753d033",
"company_id": "51580d02-597b-498c-ad7f-f9527c2c8984",
"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": "1df04cb0-1cb0-4f41-9d03-b243a66970de",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "4fff5b1f-0925-4d45-b7a9-3f8431619146",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e4fc354b-ff63-4742-b43b-9fac387d1a49",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "185d2c52-221e-4fe3-8b14-1ebece4d27a0",
"company_code": "sample string 5",
"company": {
"id": "30e55ef5-9853-4fd6-ae37-827f52fb6f66",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-08T16:01:17.745798+00:00",
"sales_territory_id": "5b0f0402-7644-43a0-b09e-d3bf0368e96b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ddc9dc67-4d54-4f59-9a3b-1bccb06ec32a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8fd98989-10c3-433f-addb-9923f3c84b39",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e79ac2d9-a0ec-4ba9-9697-efde02837fa9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a87e0918-e664-4af7-a5e7-2e79668ac3fd",
"db_currency_id": "6a4bc4f0-e509-4999-9a05-9a594c229195",
"db_language_id": "eacc0b1f-aa4c-4da8-9e98-2799496ff535",
"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-10-08T16:01:17.745798+00:00"
},
"modified_dateutc": "2026-10-08T16:01:17.745798+00:00"
},
"marketing_segment_id": "3198bac0-1224-4cb5-900c-df151a1f66b4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "76f154c3-46c8-45cc-bc3b-98796eb49f6e",
"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": "1878f1ef-0f94-4106-91bc-82927a4b4da3",
"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": "b134c3d1-837f-4876-8bcb-c29a3c509e8d",
"db_country_code": "sample string 28",
"feelist_id": "518f6432-3777-4575-a0f2-06e29167da0b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b43fd5d0-3b07-4b3d-a39f-c54dda58ce34",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "71b66000-7990-4f37-8afd-5cf85d0baf50",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-08T16:01:17.745798+00:00",
"db_currency_id": "abd6fc86-3344-4148-8854-8144424be32b",
"db_currency_code": "sample string 10"
},
"company_type_id": "6c716b14-e56f-46b2-9769-0f59003b3a57",
"company_type_name": "sample string 32",
"company_type": {
"id": "45bd70f0-3d73-448f-a31f-cca3fce7091a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "558d621f-0018-47b6-a6f9-f665159c7942",
"sales_organization_code": "sample string 5"
},
"db_language_id": "29a74d27-34f2-4a93-abd4-57860b89dacb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2d2aff90-d4e8-4aa8-8925-3e55df7f0742",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b1537d74-4497-43fb-b9a9-701457ca6cb7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "730ed9a4-2750-457c-83ee-afada66f9d58",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-08T16:01:17.745798+00:00"
},
"company_sector_id": "c1481039-58b5-4294-8170-6a4effe2bb2e",
"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": "643b4dd8-e9a1-4876-8015-a30614e0f71e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "54000635-8009-446a-9206-bc5d8c4f90fc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c36fb10a-4f47-488d-b2a5-d78722f06a82",
"account_manager_user_code": "sample string 56",
"company_status_id": "e9e0a050-b124-4f87-b4f7-3aa0b8843bfc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-08T16:01:17.745798+00:00",
"id2": 60
},
"db_language_id": "76000ee8-6d5f-461d-b210-6bf25c882de5",
"db_language_code": "sample string 7",
"db_title_id": "2ddeade7-31ec-4b13-b376-9c854c387700",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-08T16:01:17.745798+00:00",
"create_date": "2026-10-08T16:01:17.745798+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-10-08T16:01:17.745798+00:00"
},
"modified_dateutc": "2026-10-08T16:01:17.745798+00:00",
"id2": 22
}