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": "6f6574e6-7a47-4d32-ad31-d3b8cbbb444a",
"_parent_id": "7fd1302f-bf0a-4e3c-a38d-3be2063742df",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "23d2cb6b-9263-4c09-8beb-f96b58dc72c8",
"company_id": "9f7f3230-b57a-45f0-ae4a-47c983857401",
"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": "a1de66a2-362f-4121-8ecb-50b4758c044a",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "b13564cb-6c45-46c5-84c4-aa5178079621",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "38c42bd7-ed06-42b5-b98d-7f775e074fde",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5721baf5-86c3-4faf-9b9c-29cf1496e4f4",
"company_code": "sample string 5",
"company": {
"id": "6491f14b-78af-4094-96ac-76aa292afdd2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-21T23:54:33.2083113+00:00",
"sales_territory_id": "28c7628f-3c44-4647-aaf7-c2cbe022e958",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b3d671c9-9c85-48db-8f18-bb918555dc28",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ec48e122-b858-4bdd-974c-979f26f593b1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3ceb4a43-f66c-4ccb-a911-a706ce787fc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aedccc52-7ccf-4308-83ff-855fb51fb3ee",
"db_currency_id": "37fabe4e-0a76-4a8e-9647-78d85227cea4",
"db_language_id": "a73ba3ea-447a-49df-a3b5-d7bdda71bf33",
"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-11-21T23:54:33.2083113+00:00"
},
"modified_dateutc": "2025-11-21T23:54:33.2083113+00:00"
},
"marketing_segment_id": "ae2b820b-0c8d-4daf-8e49-649b7816f41d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "fee3c4b9-67a6-4de2-b0d1-6043b9b3d594",
"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": "6fd5c052-40f5-4c4b-8776-8cb9eebfdbb3",
"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": "1b89e7ab-3b55-4f73-817f-959cd4e37df5",
"db_country_code": "sample string 28",
"feelist_id": "cf099e93-80b3-4ea2-a4c4-8d54b3953fc5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "75c21633-a41a-4d7e-af4f-b724becd4156",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c04a9a33-aa23-4cb0-aadf-6336af4636a5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-21T23:54:33.2083113+00:00",
"db_currency_id": "d9788856-d081-4a0a-a92b-3dc9dc1ec66d",
"db_currency_code": "sample string 10"
},
"company_type_id": "00d70f6d-3451-4543-bc7f-71fda94333d0",
"company_type_name": "sample string 32",
"company_type": {
"id": "05b47a95-f218-4098-9038-ccea12672238",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1d76a625-1202-47da-9b69-ed79928948c4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7b3b6bb8-1e95-4a94-b78d-b50856b2ac67",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ed9e8150-f23f-4994-9329-b5872b944a9b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6df88539-1566-4cad-abdb-44f9e21b7128",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e382a1a4-be4d-4598-afcf-18fcb0693062",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-21T23:54:33.2083113+00:00"
},
"company_sector_id": "d0aee227-b90e-4305-a263-342f9c31aa4c",
"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": "ce0743cf-f156-4492-8ca7-6e39cd7426ee",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e8b14425-bd49-4797-8b09-8dd9595014ef",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "61789f6f-3154-4399-96e4-5c31e3800aab",
"account_manager_user_code": "sample string 56",
"company_status_id": "ed5a5ff0-84b1-4ab2-9006-66a1678c58fa",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-21T23:54:33.2083113+00:00",
"id2": 60
},
"db_language_id": "3977b1e2-232a-4f73-b894-577e23ae27ea",
"db_language_code": "sample string 7",
"db_title_id": "9f246838-11eb-4312-9c3c-0a3799cc1382",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-21T23:54:33.2083113+00:00",
"create_date": "2025-11-21T23:54:33.2083113+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-11-21T23:54:33.2083113+00:00"
},
"modified_dateutc": "2025-11-21T23:54:33.2083113+00:00",
"id2": 22
}