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": "cd429514-3cc2-4b4f-b746-bcca1f3acfa0",
"_parent_id": "4c9b0da9-70a0-4900-a416-8ec07582d920",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "b582063e-f457-4cd9-afa5-243c7705a4a3",
"company_id": "f8132b88-afa8-481b-b51e-3e776bf3ae77",
"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": "40a05cad-c3ee-4f6c-b5e1-e06e942cb9b6",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "2e301377-d218-4a07-a38a-f12d5ff58c7f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "f760fcd7-df8b-4ce2-a363-da5372af8eb0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "33677848-d2be-42c9-8de4-ecc525ada7e1",
"company_code": "sample string 5",
"company": {
"id": "8742178d-b94d-4c01-a5ad-c61fcb982528",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-05T03:44:05.1944121+00:00",
"sales_territory_id": "9338e736-ce45-4643-9dd8-f294003f8fc4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9adb98e7-6e13-4fe4-a5cc-8b71792a91a1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d19e46d3-c309-4fd6-81ef-7e6f59b8a141",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d273a030-9271-4a82-b99c-e7a8062da9d9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "39a654d8-d7f0-4670-981b-928daf090db6",
"db_currency_id": "800e50c1-7a4e-4fc0-8e8f-848dd3a0d533",
"db_language_id": "5b8ce588-4c85-4309-9213-558a3a90b30c",
"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-05T03:44:05.1944121+00:00"
},
"modified_dateutc": "2026-07-05T03:44:05.1944121+00:00"
},
"marketing_segment_id": "8c7981f8-3fbd-4688-a3e5-c27816b2c81e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "02ddd61e-165e-46a3-a9b7-02fd89af3886",
"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": "a1f26fa0-1a55-4da6-bac6-8a1d79b03b8b",
"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": "111d34f0-630a-4909-827e-44a89fbaee5c",
"db_country_code": "sample string 28",
"feelist_id": "150efd2a-e8d8-46a5-97e3-c83378cddf46",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2cdf5f28-47b3-4e25-9593-3289a71bc091",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "53e315a0-b007-46a2-b266-0b99f44f0d64",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-05T03:44:05.1944121+00:00",
"db_currency_id": "72fa1c9e-816e-424e-a9a2-530d20b1954c",
"db_currency_code": "sample string 10"
},
"company_type_id": "7feeef57-5447-4268-b81b-1b2e6bd422b4",
"company_type_name": "sample string 32",
"company_type": {
"id": "5c9471a4-d9e5-498d-9a63-2238f1ba7e27",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1726abc0-37b6-425e-bb38-678449925dcd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b4c4b933-2674-4c08-a906-9d0b30dd12c1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "213cd170-5efa-4da8-9cc0-88368c66f6bc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "56305bda-799b-4e17-81de-4b6dafcb50fd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "eb749149-68b0-402c-ae63-8cea93f4f12c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-05T03:44:05.1944121+00:00"
},
"company_sector_id": "81619108-45c1-4f6e-ab9c-bfeabd26d5db",
"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": "db3c9d75-4e4d-445e-ae08-080a8465c8af",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6eee67db-7753-416b-b16a-b207e1d85d6a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "92acf56c-fc9d-4335-a67a-d1c802af9353",
"account_manager_user_code": "sample string 56",
"company_status_id": "4af66c7f-5c77-4551-963a-5b5f16583709",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-05T03:44:05.1944121+00:00",
"id2": 60
},
"db_language_id": "dde69718-d2fd-4069-a714-8efa28b98c59",
"db_language_code": "sample string 7",
"db_title_id": "0680aa54-9bc4-4c56-8c08-b9ab8363589b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-05T03:44:05.1944121+00:00",
"create_date": "2026-07-05T03:44:05.1944121+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-05T03:44:05.1944121+00:00"
},
"modified_dateutc": "2026-07-05T03:44:05.1944121+00:00",
"id2": 22
}