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": "83ea4f98-4838-4076-903a-cf1737a146b3",
"_parent_id": "06d1a015-4427-467a-b921-618af2b1d4e2",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "f0f52a47-f873-43a1-a8d1-f046b6a83cab",
"company_id": "1abe482a-919c-48a3-92a4-15126a147816",
"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": "b3a68b54-1534-46e8-87df-e8cb7e2577c3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "4dcc85f7-fc2b-477a-a2a0-f1cdbc4ac2fb",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "3731f53a-8f3a-4897-88d6-8cb948fad08c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "27bdba82-b1a8-4a06-992e-c01633a4214c",
"company_code": "sample string 5",
"company": {
"id": "508dfbd3-3ffe-43cf-bcc3-a8f218e0386a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-07T22:55:34.0453868+00:00",
"sales_territory_id": "6549f338-cf54-44a7-b487-64e1504e674e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "80f6b697-d39f-49d2-9341-3e776802c990",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3577cb7c-d416-441f-bd53-b5108e129152",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "da99227f-70af-4ce3-82a4-26b51b2aa682",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8677a17d-9e4c-4521-b1b6-b7bae86222ac",
"db_currency_id": "56f44c24-ed97-4603-86a8-e207e98c541a",
"db_language_id": "7f612132-0074-4aab-9503-9d4d9f770fbe",
"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": "2025-06-07T22:55:34.0453868+00:00"
},
"modified_dateutc": "2025-06-07T22:55:34.0453868+00:00"
},
"marketing_segment_id": "001e3048-cc3c-49c0-887d-8acc105f63ed",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cfbb83c5-e073-47e9-a3b6-1c67f68be2cb",
"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": "8d45250e-0074-471b-ada6-366992d28851",
"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": "81850f8f-38d1-4514-be54-f0c0035b4a90",
"db_country_code": "sample string 28",
"feelist_id": "b9964a93-59ed-4d96-9e63-5c75e9e2906c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ca51a072-1a74-4e91-88f5-786e7a6dc159",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d0662812-d3ce-4ac9-a96e-42ace07227cd",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-07T22:55:34.0453868+00:00",
"db_currency_id": "077f0b74-be83-41c4-9a83-6b73ca0bcb02",
"db_currency_code": "sample string 10"
},
"company_type_id": "99941589-d397-4ef7-bfd9-4c6679444105",
"company_type_name": "sample string 32",
"company_type": {
"id": "d400383a-e6ca-4220-aa6a-7e447a4ccae7",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "37fd4a62-70c0-4ee9-b7f8-a8d68bcdc529",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fe9338e6-f077-4e0c-8edc-740f581c25e5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e222e7f5-c48f-4fbe-847d-60471b749e8c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "de7b8628-23af-4aa0-a03d-4184ef6364ed",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2b261e30-ed8c-42e6-9c54-9832a97f9b27",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-07T22:55:34.0453868+00:00"
},
"company_sector_id": "8544aca6-3bfe-4ae4-8dc1-7c157513f47a",
"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": "ea5540a2-7ce5-4986-a6d2-da17dee7e773",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2c944287-1f51-4f23-aa8d-b6c2f863040a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b0e9d54d-8d79-4511-b562-b20394e56661",
"account_manager_user_code": "sample string 56",
"company_status_id": "7bfc06e9-2f71-4917-83c5-7b1884f21cb0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-07T22:55:34.0453868+00:00",
"id2": 60
},
"db_language_id": "ce09cecb-37e8-42ff-b740-3c4ea4b9b050",
"db_language_code": "sample string 7",
"db_title_id": "65a5cba8-a2fb-4709-8319-dcea6d355deb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-07T22:55:34.0453868+00:00",
"create_date": "2025-06-07T22:55:34.0453868+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": "2025-06-07T22:55:34.0453868+00:00"
},
"modified_dateutc": "2025-06-07T22:55:34.0453868+00:00",
"id2": 22
}