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": "6b84cafa-b3e9-44ac-8874-ef37796bddec",
"_parent_id": "6e3c9cb8-0ba1-4c6f-9055-5b10f4c66cc0",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6c09f955-130c-49f4-9bda-60299871c738",
"company_id": "4ef62b43-8f47-4484-b8e7-7b6fc892c284",
"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": "01df2818-e950-49e7-8afa-fbbadf1da4e0",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "c3b538e7-8c9a-4725-979f-a90782371354",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "f0eccc66-b9a8-4f4e-8178-633b2844cd83",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "188c7f29-a07a-4f5d-b727-bd34ea27d387",
"company_code": "sample string 5",
"company": {
"id": "8f561586-1841-47b1-93b9-d4f67fedfe6b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-23T09:23:43.8584892+00:00",
"sales_territory_id": "96702be8-4643-4a5a-ab04-26087113cb77",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "49fa2ad2-1b06-4760-b38f-7cae1c017cf6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "959bdd7b-d419-499e-b53f-73fd85dd6b51",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5a83511f-69ac-4214-9bca-705132926c76",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4d3d013-9555-4858-b181-8545977c4dcc",
"db_currency_id": "3af63167-6cce-4519-a41f-a76708abdbe8",
"db_language_id": "e562aa58-04d6-4058-bf1d-2820be408e76",
"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-23T09:23:43.8584892+00:00"
},
"modified_dateutc": "2026-10-23T09:23:43.8584892+00:00"
},
"marketing_segment_id": "98104815-4458-4516-bf23-d713c0ff8090",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a5ffc8ed-0c07-420a-a531-d080d52a8d0c",
"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": "ea37ef4f-fd6d-4d8c-8ce2-562f025164f0",
"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": "02b5fe2d-79b5-4608-8855-c61a738cb1df",
"db_country_code": "sample string 28",
"feelist_id": "af8e9a70-d0b9-455e-b6d0-fc1490817f25",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "152d7444-4e34-4803-823c-4608f419e93f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a401c2f6-18b8-443d-9d4b-2f015ec97c33",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-23T09:23:43.8584892+00:00",
"db_currency_id": "4a848032-7105-41ee-8c11-38c9234db741",
"db_currency_code": "sample string 10"
},
"company_type_id": "7c754f2d-7af7-4369-b6d1-0ecb64d676b2",
"company_type_name": "sample string 32",
"company_type": {
"id": "cbebe82e-fe84-4448-bfa2-68e77205bca3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cc1156fa-75f4-42e3-8bb4-4b73ed02fd3e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a529cc76-8802-4310-bd33-46da9930e3d6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "daf3ea97-3268-4730-b96a-f141a42a9dd6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5ed37af9-d1b8-49f4-9392-df4e963e441b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fcb29f6a-9ddf-4b89-9110-efc09bc7b403",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-23T09:23:43.8584892+00:00"
},
"company_sector_id": "ad9dff58-9049-4968-bce9-e40fa9db6052",
"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": "a3763c9f-55d9-40c3-aebd-7417630c4497",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6d395305-df06-4df0-a1c8-d0d8ab39c6d8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "db7a0cb4-5550-4f30-af22-a0bf814c5188",
"account_manager_user_code": "sample string 56",
"company_status_id": "6708c352-4009-433d-ae18-8a07c1953dd1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-23T09:23:43.8584892+00:00",
"id2": 60
},
"db_language_id": "05b7e921-646d-4fcd-8109-7ba7b897f131",
"db_language_code": "sample string 7",
"db_title_id": "091ee5c4-4f0d-47cb-ba49-8b33185aa427",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-23T09:23:43.8584892+00:00",
"create_date": "2026-10-23T09:23:43.8584892+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-23T09:23:43.8584892+00:00"
},
"modified_dateutc": "2026-10-23T09:23:43.8584892+00:00",
"id2": 22
}