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": "775c6c23-bd4e-4c17-ade7-aca08f55c93c",
"_parent_id": "a53d5b23-67a7-45f0-a219-cfda3cdb9324",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6f8f55f3-fd9f-4a2c-915d-7b4947be3b55",
"company_id": "c5358c56-ab80-48aa-8015-b09885d18286",
"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": "83353c65-239a-4347-984c-fbae7a45d73a",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "5b69db80-8265-47f5-8f36-d8384a3a8a28",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "092b4444-274f-48db-a298-64a47f19cef5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "41450931-0c36-4cab-a38b-00d58aa890d9",
"company_code": "sample string 5",
"company": {
"id": "27095b71-aaea-44da-9fd2-4819743c2db7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-28T01:07:25.5397998+00:00",
"sales_territory_id": "1e3544ef-4540-4ddb-88ee-f89498f2fd88",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1ba5c83d-fb43-4f5f-a7fd-cfd9674f81b3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0e025d33-2e52-4ed9-9ac0-625e41c10550",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d8806d91-35d6-49be-a891-62596677d944",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f4b1141c-db72-455b-8c5b-c1f04220869b",
"db_currency_id": "7fa95b47-cb42-4a77-bbb0-4529361e9c98",
"db_language_id": "bd0c76d9-c46e-407c-9347-6a9eee53f93a",
"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-05-28T01:07:25.5397998+00:00"
},
"modified_dateutc": "2025-05-28T01:07:25.5397998+00:00"
},
"marketing_segment_id": "07fb01fc-8c4d-4999-8629-a389271d6ef2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "15325594-c68f-4bc7-a10a-e253f0d817e9",
"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": "d1b87db2-2558-4aef-a1ae-20d16d3346f2",
"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": "3cadabc9-5ffc-4849-926a-2ae15afd078a",
"db_country_code": "sample string 28",
"feelist_id": "86b30292-5f2f-4a16-8bf6-02c641c0d73f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6b1f5765-9634-4f9a-ba0d-cfd0dc017559",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b7ce8ecd-b5d4-4898-bb6b-1aa234f9ea74",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-28T01:07:25.5397998+00:00",
"db_currency_id": "a0c73e8f-371b-4ec4-8d6b-1b72aeab5613",
"db_currency_code": "sample string 10"
},
"company_type_id": "2b73b42e-47f0-41cc-b5fe-3018c7f71123",
"company_type_name": "sample string 32",
"company_type": {
"id": "dcf933ff-e634-4d88-8b08-5566ca75e675",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5b725f90-bbfd-4390-a048-95f581748693",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b34ab11d-cb7e-42c4-b9d5-3899e2637f0a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f76cdb87-888e-4d70-8c7c-121cf0f44734",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c14a3740-4323-4173-a2f0-adf7da1762b4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "38b8d8c5-7748-44d0-973c-fcb9db5ce68e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-28T01:07:25.5397998+00:00"
},
"company_sector_id": "acfde4e4-a965-4ac1-abdc-ad72727df9e8",
"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": "ba91b3d7-1a5b-425d-b931-cc6e9007bf96",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4b534d5c-4b47-4cad-b6b9-699033d556e3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "30e9fc41-0a19-4e27-8ffd-5d245ac7928a",
"account_manager_user_code": "sample string 56",
"company_status_id": "f499227a-7954-449f-b81b-92c86e346dd2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-28T01:07:25.5397998+00:00",
"id2": 60
},
"db_language_id": "719e87fe-56f9-477b-8442-49890d736d59",
"db_language_code": "sample string 7",
"db_title_id": "9892f019-a2f3-44da-b488-13823c669a34",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-28T01:07:25.5397998+00:00",
"create_date": "2025-05-28T01:07:25.5397998+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-05-28T01:07:25.5397998+00:00"
},
"modified_dateutc": "2025-05-28T01:07:25.5397998+00:00",
"id2": 22
}