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": "2229d659-a7f6-4d73-8790-47bfdc6002fd",
"_parent_id": "5243e3b1-d49e-46fe-9203-149a2a494f98",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "0dcd41ac-0988-480a-9243-919f7ef8a097",
"company_id": "951540c9-1b2f-47e8-9336-d85f0a0b270f",
"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": "888a829b-aca0-467f-a904-bde9a4adc0ad",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "f53e8125-f9d6-42da-8dbe-680707f50edc",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "6b5f9d7e-d516-4898-9b81-974a8c1dd97f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bc188de1-42d1-4385-a65c-c8ed107c25b4",
"company_code": "sample string 5",
"company": {
"id": "806c999f-585e-44bb-99ac-800e61e169a0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-10T06:05:44.4971898+00:00",
"sales_territory_id": "98ab8191-bbf2-4e2a-9aba-b86fa55c374a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b128da47-93ec-4da1-96d6-2a3c17c28ae1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a63cfe0e-1ea7-480e-b409-676cd0f0ce1a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "48c37433-3eb8-425c-806f-cdfb334daf53",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ff480f9b-73fc-482a-a4c1-f742380273d2",
"db_currency_id": "0d84ba0c-d5e8-42bd-bcc7-95900f0659a4",
"db_language_id": "a70f5689-96b6-4ccf-b9d3-c7515b640627",
"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-09-10T06:05:44.4971898+00:00"
},
"modified_dateutc": "2026-09-10T06:05:44.4971898+00:00"
},
"marketing_segment_id": "3f3c38de-4774-4d77-a005-1b7423f17938",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d7536912-f2de-439f-8b52-bb0a3761aec0",
"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": "0f62c106-3430-4ad7-b82b-161c4a67eabf",
"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": "05763155-d6fa-48d0-b525-153215703ed5",
"db_country_code": "sample string 28",
"feelist_id": "d8406cf2-ecba-4f42-8110-4bd2bc153061",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b498d333-440e-4c77-ad56-621610536320",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d4963bdb-08a3-4c8d-84db-1ea1d1829b41",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-10T06:05:44.4971898+00:00",
"db_currency_id": "54e1e2f5-2d84-4264-a2fe-7c72b70ff28b",
"db_currency_code": "sample string 10"
},
"company_type_id": "ebcfe1c2-ac5a-4b1d-ac68-febf2c101c89",
"company_type_name": "sample string 32",
"company_type": {
"id": "646802c6-d11a-4b1e-86e3-01f7a573b1dc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c7226b66-a09c-4cc1-827e-0e15057a8e3b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fbf82e5f-b603-4911-84bf-1bb9289e8d66",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1b4bea38-6bc6-4156-a178-10e339b357c7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4cb931ba-484a-4f13-adaa-4cb161e01508",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ad6f4189-37e0-44eb-aa6c-d6e47b688dcb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-10T06:05:44.4971898+00:00"
},
"company_sector_id": "78d237fc-bc0f-40ca-8b15-d7088efc4c0c",
"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": "1556caee-9048-4012-82f9-9aad9a2837f2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3d739e30-20b6-4990-ba25-d80a72514b95",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fedb3814-97d7-42cf-91e9-2d76c690cc89",
"account_manager_user_code": "sample string 56",
"company_status_id": "b3a756df-6c11-4be2-9d40-1069f560b0e8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-10T06:05:44.4971898+00:00",
"id2": 60
},
"db_language_id": "69da702f-d967-43cd-8d8b-fffffdde048c",
"db_language_code": "sample string 7",
"db_title_id": "d47ccff0-fb1d-434b-a552-fb0d21dfeedf",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-10T06:05:44.4971898+00:00",
"create_date": "2026-09-10T06:05:44.4971898+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-09-10T06:05:44.4971898+00:00"
},
"modified_dateutc": "2026-09-10T06:05:44.4971898+00:00",
"id2": 22
}