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
{
"id": "e9170429-dd16-459c-b922-5c2a448ceeaa",
"_parent_id": "cdd751f5-4f47-4016-8cc5-b51b4cf04e74",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "d9e70f84-3295-4dca-8c66-6e46928d63b5",
"company_id": "266207f0-3093-4999-9500-2d8eaf5210b3",
"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": "31704b4d-2d03-4a32-8fd8-a2aaee3b04ff",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "703a90fb-e2fe-4875-9457-99177eb13737",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "13852ae3-2137-452f-bbf2-903098315b5e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0fada03d-79e1-43d6-b450-be16cfc2864e",
"company_code": "sample string 5",
"company": {
"id": "39a3f77b-fdbf-442d-9662-3551f83ae763",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-22T18:05:10.3920854+00:00",
"sales_territory_id": "4495fe91-86e9-4d35-a8c8-2129b835d29d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ce0c698b-3265-4d9a-a870-8e6eb6a2b7bc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "af763b59-0db1-4b6f-9aca-ba8407454cca",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a1836e6d-3827-44b1-9731-4f518a827c55",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8f5fbd3b-89f2-4263-a0e6-f2959d70b108",
"db_currency_id": "4830609c-f099-46fe-911b-ee56b3269380",
"db_language_id": "1e7f11ed-a821-4953-a9db-202ee450c0aa",
"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-11-22T18:05:10.3920854+00:00"
},
"modified_dateutc": "2026-11-22T18:05:10.3920854+00:00"
},
"marketing_segment_id": "50e03a41-0ce1-4c2b-80b2-9633635a57e3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "081f94e7-1e9a-4f3f-971f-54f60d18bb47",
"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": "21d23e14-8124-4fb7-9e80-84df924e456a",
"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": "e6b6243c-c814-4a67-be92-c17be1697560",
"db_country_code": "sample string 28",
"feelist_id": "968901d3-d470-4fcf-887e-740d779b667c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "35039cec-dfd0-4db0-aac6-624d7e3c9c35",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4df1e775-9572-4d80-b0c0-e4c2bbcc64b5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-22T18:05:10.3920854+00:00",
"db_currency_id": "3850298a-8af1-44bb-97dd-c1a6fe5ca941",
"db_currency_code": "sample string 10"
},
"company_type_id": "d96278cd-0e27-49bf-b494-6dec3cc7c08e",
"company_type_name": "sample string 32",
"company_type": {
"id": "eac478f3-1008-4b97-bec2-87127dac01cb",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c1c206ce-157c-43e3-b45d-2bea669fdbba",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0dbd0e90-935e-4206-8559-b8d0e5f6be1b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ee4be7fa-d8fa-4e53-b861-0d31ae737eaf",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c4a46d7c-8cfb-4573-af29-9b11a6db17ad",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8885e870-d640-4871-bfc4-4ec7d9244728",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-22T18:05:10.4029904+00:00"
},
"company_sector_id": "7768c54f-3827-4e44-a259-a29e71a156e5",
"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": "8efdeac5-163b-497e-9c86-b4e1ba184987",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f2f3db5b-7151-436d-9a28-c0170eb3ff9e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5b8d9c45-7567-41a4-b0cd-56d62e55aee7",
"account_manager_user_code": "sample string 56",
"company_status_id": "9c6bc583-2ffe-45ff-b3a3-55a406ba39ed",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-22T18:05:10.4029904+00:00",
"id2": 60
},
"db_language_id": "3c7b8569-3b58-48bc-9eff-07d05dca9689",
"db_language_code": "sample string 7",
"db_title_id": "6cdde20f-2c30-493c-a7a4-0aaad3ad82cb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-22T18:05:10.4029904+00:00",
"create_date": "2026-11-22T18:05:10.4029904+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-11-22T18:05:10.4029904+00:00"
},
"modified_dateutc": "2026-11-22T18:05:10.4029904+00:00",
"id2": 22
}