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": "75653f1d-40ea-4bd5-806f-11f6701c832d",
"_parent_id": "81b360c6-dc5a-42d6-80bb-3dfb09e7f7e6",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "15839e19-6cca-4975-b817-40ca5f4ebfd6",
"company_id": "d1530a76-461a-4fe9-935a-315c499bd908",
"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": "db38a168-ff7c-4763-a9ae-ae9045a2fce0",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "b4d448fc-e5b5-4eb7-a414-ab1a3ff748dc",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "680e2ea5-fae9-4da1-bdb6-6b2665b72d1e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c3d1fa3e-3dad-4e5a-b2a3-67485a8faded",
"company_code": "sample string 5",
"company": {
"id": "1522f9be-eedd-49bb-9863-d32e70fa2fa9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-05T17:39:04.7872687+00:00",
"sales_territory_id": "5b952395-861a-4823-8ebd-3fd399c31d1b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e7b64f6b-c858-4d81-a39c-2e725f920b0f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f0a34a72-de44-4211-bb6f-bd339536b391",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bc163570-255c-4095-a46f-71c8c5159477",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e081fa44-0f81-491f-97fb-4dcbe2ec03f2",
"db_currency_id": "d67ff3df-3514-4ad0-b713-20f5957ac5c7",
"db_language_id": "36ba62a7-6dc7-415f-a643-5ef116aa623a",
"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-07-05T17:39:04.7872687+00:00"
},
"modified_dateutc": "2025-07-05T17:39:04.7872687+00:00"
},
"marketing_segment_id": "b21b0b3e-160b-439a-bd28-9930061da65d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1eaaad9f-e110-408a-8263-68644a1ac849",
"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": "36f54bc3-c242-49c6-ac95-dbb1c8aaeca9",
"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": "a3099432-f972-4eaf-a9d3-cd3684bd8260",
"db_country_code": "sample string 28",
"feelist_id": "5825a8b1-cca3-42d5-ae11-bdf95839f52d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7ed1c2a1-1ab9-4087-8f14-c1caf212445a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "67899b0d-cf6d-41cc-8d71-b95e3028faff",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-05T17:39:04.8028951+00:00",
"db_currency_id": "4686205b-fa58-418e-b684-0d819bf870d3",
"db_currency_code": "sample string 10"
},
"company_type_id": "b39efb90-b438-49a0-857e-e08cc6e2c5d0",
"company_type_name": "sample string 32",
"company_type": {
"id": "6a330e0e-a64d-4173-a5a0-431002d8a534",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "74bb0e1a-4140-4e87-a3c7-42302bcab439",
"sales_organization_code": "sample string 5"
},
"db_language_id": "395a6364-60c6-45f1-9f20-2b0770049e87",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "70da8e3b-a436-439b-ac95-de94d288b0e6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "025c48ed-67d0-4a79-8f2b-d56491f20412",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "55126d70-db9c-4f92-b889-d5dc5cda48c5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-05T17:39:04.8028951+00:00"
},
"company_sector_id": "49b15adf-46e2-4e31-9d00-e85537df9606",
"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": "82b41aa7-0062-483d-a6ac-c788bd213dbe",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "84d8ef4c-cb4a-4e3a-84c6-6e91041b824c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f2d72b90-ec61-47da-a50c-3c0662817474",
"account_manager_user_code": "sample string 56",
"company_status_id": "c7fd6da3-e7d5-4ce7-91c9-5c6871d982de",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-05T17:39:04.8028951+00:00",
"id2": 60
},
"db_language_id": "a12d43a4-9a8d-4585-b839-27db5d088042",
"db_language_code": "sample string 7",
"db_title_id": "446b62be-1078-433c-81ad-fc35be822eeb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-05T17:39:04.8028951+00:00",
"create_date": "2025-07-05T17:39:04.8028951+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-07-05T17:39:04.8028951+00:00"
},
"modified_dateutc": "2025-07-05T17:39:04.8028951+00:00",
"id2": 22
}