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": "c6063e78-ab08-4f9f-a2d0-ac3f3be48778",
"_parent_id": "85bf3f77-30c1-4147-b131-54f2167c5965",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "addd0e3e-206e-46b3-815c-d46314ba3e0f",
"company_id": "60d14e85-0e7f-4ca8-8240-21b809d1a12b",
"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": "054450de-313b-4d2e-b206-2c4a4b62ad90",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "f3585f7c-da13-4bc1-b15b-1df4eb9f156f",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "854f567a-38d0-4cc8-ad4c-f9136949fdb2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dc0691c4-3326-4469-9a48-f9539ee85db0",
"company_code": "sample string 5",
"company": {
"id": "b7f36dfa-03b8-4e83-823b-6fbfcadd57b7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-21T17:31:27.508526+00:00",
"sales_territory_id": "2fdb2cb3-bc02-498b-8089-1c1cf7cc32a7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "95281df1-5a5b-4b4f-bae0-fe0245c42c65",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0c1e06c6-2fdc-40c9-88bd-42789adeea54",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1dff8fe5-9a97-40b7-abaa-46afbf800949",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2c4600fd-c1e9-45be-93b3-e367af4b3852",
"db_currency_id": "17f4c0c3-18d1-4cfa-9bb8-14c5bb149a62",
"db_language_id": "d1893127-2b8f-4ca2-a08c-26cf47a4a6c8",
"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-21T17:31:27.508526+00:00"
},
"modified_dateutc": "2026-08-21T17:31:27.508526+00:00"
},
"marketing_segment_id": "73b6fda3-0872-404a-8515-dbf31ec33339",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "57e02cad-64cb-4b23-adbc-0ea8a6b6464a",
"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": "01df36d9-501f-4b62-9cc7-acdc50b452ef",
"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": "9e963076-eb79-404d-aee4-331c45576b78",
"db_country_code": "sample string 28",
"feelist_id": "f7e259df-c45d-4cb2-b10a-777691890cd2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "17ec35b2-5964-42d4-a4d0-27226f7bc907",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ac744520-7a34-4f97-8b83-16416c719ed2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-21T17:31:27.508526+00:00",
"db_currency_id": "1d974eb2-a4f9-4f6b-b079-4cb7395720f8",
"db_currency_code": "sample string 10"
},
"company_type_id": "7e338028-7733-4966-b80f-a0caac7a092b",
"company_type_name": "sample string 32",
"company_type": {
"id": "eb01576f-2a84-4385-802c-ae93303eccf9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "11dc9905-ba43-40f6-8e94-cb4060893dc6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "149e242a-eda0-4d33-8efd-7762432bd01d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3e7ee845-bf65-4029-89fa-e29de840052d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d5901de8-8edd-4ab6-9716-0e77e3c21db0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a9914e79-c4d4-4d31-baf6-8e0fce3c01db",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-21T17:31:27.508526+00:00"
},
"company_sector_id": "38700911-3d96-49fc-9ed0-15aade66b7d1",
"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": "1dfeeb7b-f0ff-434c-88a9-eb5d9e77c005",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "757d20a7-aa10-46be-8866-b38fe9e0ddb3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5de85964-e527-4f55-b674-d71bebf1d6a0",
"account_manager_user_code": "sample string 56",
"company_status_id": "87069cac-f375-4cb6-9d90-d364d44dd321",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-21T17:31:27.508526+00:00",
"id2": 60
},
"db_language_id": "91e0b0e4-3a3d-4e02-9b1b-3ea19b7cb335",
"db_language_code": "sample string 7",
"db_title_id": "b65b5fbd-d0e1-45a4-846d-e855673c62c1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-21T17:31:27.508526+00:00",
"create_date": "2026-08-21T17:31:27.508526+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-21T17:31:27.508526+00:00"
},
"modified_dateutc": "2026-08-21T17:31:27.508526+00:00",
"id2": 22
}