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": "f635c45e-1424-45de-9478-d9d00fd4b37c",
"_parent_id": "65f4a851-7d77-4ee6-b3d0-657f2b8971c3",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9ef4a58e-8f99-4ec8-a28f-00c603237664",
"company_id": "bd79048d-3e36-414e-9790-42127e1c8e6b",
"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": "46c1399e-85f1-4815-aa78-fc67c7e7b247",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "652e365e-99d4-4c35-a1cd-573560ee2291",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "ee12a017-a76a-4218-9c57-beb4304cecf4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "63999c80-f260-4126-a080-e73b0622d50f",
"company_code": "sample string 5",
"company": {
"id": "2882855f-ac19-4b76-ab66-8f5666731ddb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-02-05T06:46:45.8141628+00:00",
"sales_territory_id": "481b0bb1-1523-40ff-a814-2c09c83fa715",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "39d05580-ce7a-498f-9ae7-277fe3c5e458",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5c944c17-ef94-445b-8842-577871ef06a9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b5d57b6b-5900-4bc7-81d5-2c2e313683fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da4b0037-4f01-46bb-bcaa-6ff7518e5e8b",
"db_currency_id": "7b7b662f-590b-43f6-89ac-128cba120134",
"db_language_id": "bf49951b-ef7b-4d44-9529-67ffb9d57b12",
"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-02-05T06:46:45.8141628+00:00"
},
"modified_dateutc": "2025-02-05T06:46:45.8141628+00:00"
},
"marketing_segment_id": "7f01fd04-16ba-437c-b1ed-c3a6280dc7b8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "91ff010b-1d6b-4c93-87f1-620f63b01278",
"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": "f67d1d63-2776-4482-b11c-eb9c6e6e22fa",
"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": "a2c6ed0d-b35c-4d1c-82cc-38058dbcb499",
"db_country_code": "sample string 28",
"feelist_id": "beedf526-402b-412a-b904-b95edd63ea71",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d7d24e4d-0483-4aaf-9c34-f986a352de36",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e006ffe0-494a-4f8f-8075-56115e7cb431",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-02-05T06:46:45.8141628+00:00",
"db_currency_id": "e113a18a-7d78-405a-8aa2-9f689e71a418",
"db_currency_code": "sample string 10"
},
"company_type_id": "deac76d9-a4e8-4e1f-ac6c-5b9d7fa5697a",
"company_type_name": "sample string 32",
"company_type": {
"id": "b018b1a5-eb01-44f9-87d8-a5fe709ec1b3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d09957a8-4f31-4212-854e-80857f640298",
"sales_organization_code": "sample string 5"
},
"db_language_id": "91a56cd2-e156-4111-a852-9e334851edcf",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "12e4290d-c03f-4301-a763-438a3fa595c6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8c468979-b708-41af-850e-1a6b2f8ab9e5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "041e4fb9-f04c-4988-8654-f21fff4049cb",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-02-05T06:46:45.8141628+00:00"
},
"company_sector_id": "0de1571c-114e-4281-9af8-843062f0c9e8",
"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": "e5cfd35d-954d-49ce-9259-69a16c180229",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9a528b39-c8fd-4130-86a0-ac3153a3dc0b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4eb86fdc-a40d-4d02-811a-ab904c2e8619",
"account_manager_user_code": "sample string 56",
"company_status_id": "5dad1893-0b89-45d2-9468-e3c8d9dab417",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-02-05T06:46:45.8141628+00:00",
"id2": 60
},
"db_language_id": "c77e05e5-9771-481f-88fc-81f63a18244c",
"db_language_code": "sample string 7",
"db_title_id": "081afca6-0962-44af-aaa9-7622cfc23ed6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-02-05T06:46:45.8141628+00:00",
"create_date": "2025-02-05T06:46:45.8141628+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-02-05T06:46:45.8141628+00:00"
},
"modified_dateutc": "2025-02-05T06:46:45.8141628+00:00",
"id2": 22
}