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": "c7b67dc1-f0fc-45fc-8b95-d8fc14f7861d",
"_parent_id": "e45da776-4bcb-4ce8-be7e-d779c3ac3861",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "857b21f9-856b-4b36-acfe-edd1bb0d2ccf",
"company_id": "f8184882-c465-4382-9136-7b544d1c958a",
"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": "f8f5a455-d2aa-47d3-a273-f9861cfb0162",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "546234be-8fcb-48e2-93bd-acc1574457e7",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6150c276-8eb1-4384-9c9a-529cd6647526",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "67806da9-01a4-4853-b4ef-c5b1f1228f33",
"company_code": "sample string 5",
"company": {
"id": "b68eaa98-778b-4230-863d-6521179bbcba",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-12T10:09:25.6227925+00:00",
"sales_territory_id": "352bf4b1-eb6d-4d8a-a27f-fa8553a6d6fa",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8cf60e17-5315-4cc3-9b2a-fa8e7bcc3aa3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "755cb815-a549-4dbb-a02d-47caa97f350e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d55ed1bb-4c45-41e0-a4cc-3359385c6a10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a07a3cbb-daec-47bf-ad2f-bc07e10a3cd9",
"db_currency_id": "b5985ab6-21c5-436e-bff9-6766002f2997",
"db_language_id": "f40965ae-fad6-4afb-83b9-9a1199a35f09",
"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-05-12T10:09:25.6227925+00:00"
},
"modified_dateutc": "2026-05-12T10:09:25.6227925+00:00"
},
"marketing_segment_id": "f21a19dc-78f8-4bbd-aa55-3deac700c6d8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ccaa937a-5ee4-4502-9f98-f6015225ae89",
"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": "38ae70b5-a468-49bf-8a68-d3d9cdbac7f3",
"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": "e0afd569-8204-47a0-ac1d-9f54796789ac",
"db_country_code": "sample string 28",
"feelist_id": "fe2c6dc1-e6ba-46fd-8d6d-d87f03e4c025",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "dc91ac4c-f534-440d-ae7b-a7fbc184672a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1f84363c-53d6-44b5-99f5-3ea9b5b5d205",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-12T10:09:25.6227925+00:00",
"db_currency_id": "8aa73e57-1e01-4471-a16c-e91421eed8dd",
"db_currency_code": "sample string 10"
},
"company_type_id": "63743d19-ea65-4728-851f-5fad45efb39b",
"company_type_name": "sample string 32",
"company_type": {
"id": "a347d23a-3e8c-47a9-8ba1-ae231d222adf",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6be7857c-8f9a-456e-b1fb-8162af68d747",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9b9798b6-bb83-4b1d-872f-227065c7f92d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8a0932c8-377f-4c79-a77f-ce6780f92787",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e10a4067-151f-470f-97da-e3bc566bfa78",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bbafc300-60b0-4d6d-93be-f1c89357db91",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-12T10:09:25.6227925+00:00"
},
"company_sector_id": "43a2b15d-3391-4dc2-b607-6dcde23905b1",
"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": "8125ab14-e6f6-4037-a626-96db399af722",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "94c860e0-f79b-418f-b59e-79dec43600e9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a5097c26-2992-409c-a944-e068bb1249ea",
"account_manager_user_code": "sample string 56",
"company_status_id": "6e84776a-a4ec-4fd4-89b4-5e9ce31405b8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-12T10:09:25.6227925+00:00",
"id2": 60
},
"db_language_id": "920ba9bb-959c-4d7b-85cc-64829dc60f3c",
"db_language_code": "sample string 7",
"db_title_id": "5a687f19-68ed-4c0f-8333-91bf645d2de8",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-12T10:09:25.6227925+00:00",
"create_date": "2026-05-12T10:09:25.6227925+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-05-12T10:09:25.6227925+00:00"
},
"modified_dateutc": "2026-05-12T10:09:25.6227925+00:00",
"id2": 22
}