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": "62e504b0-3e36-4ad3-9965-7b9e1f33986c",
"_parent_id": "9c93596f-9669-495b-9f6e-3742921680d9",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "bdbca604-288f-4661-9ddb-7b4d979c28f0",
"company_id": "e31f9dea-9ae4-4416-9b4a-617afc46e9e7",
"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": "cf671c11-cd41-4763-aa79-c54fc59c8325",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "078b3618-f3d0-4c03-8b44-ccd7ef2fac58",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "9c2f8c0c-baca-4a9a-9f99-14c5506ef7f2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "54973c01-f3b6-4ed9-939f-abfed4e7e627",
"company_code": "sample string 5",
"company": {
"id": "1e06202c-a688-4459-9da9-968bb33ba1ee",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-03-25T03:17:16.7869079+00:00",
"sales_territory_id": "643d7402-86de-45af-8c94-790270912281",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1fe55d83-92c9-4df9-a768-9720d8ef1a15",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0dbff4d2-8e68-4c23-a94f-5ad9615fe59b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9875e13f-ff1b-4e30-8645-4469cc4656b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ca9fe685-234d-4c14-9e8c-7a10e6501a45",
"db_currency_id": "9e5d8689-c898-481c-803d-902e547cb12a",
"db_language_id": "c007aa60-431b-46aa-911c-c27e63e24a53",
"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-03-25T03:17:16.7869079+00:00"
},
"modified_dateutc": "2025-03-25T03:17:16.7869079+00:00"
},
"marketing_segment_id": "385c32c9-4d03-41f6-8ba8-2e29bb327906",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e0818889-6d7f-44d0-9593-7836564bb154",
"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": "b3419d31-4a18-4c40-9286-b1dc574ae785",
"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": "ae5d6c44-52d3-47da-9dcc-9cbd1011b2dc",
"db_country_code": "sample string 28",
"feelist_id": "b61ee9c0-78a6-4030-ab01-c3e99c31d36b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "17d6f6dd-0a78-4265-96e5-e3aac8310559",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7234cb24-8529-4d8e-b474-635d69d70401",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-03-25T03:17:16.7869079+00:00",
"db_currency_id": "e1cbb9ad-ff56-474d-9fb7-8ccfee750d47",
"db_currency_code": "sample string 10"
},
"company_type_id": "8e5d09b8-afc1-43e0-89f9-f553a8b0f426",
"company_type_name": "sample string 32",
"company_type": {
"id": "bbb21fe3-0593-4135-b959-3e629a0df1df",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4d72a1aa-3ff0-4fe5-bfc8-2fd7ff38ac99",
"sales_organization_code": "sample string 5"
},
"db_language_id": "290cbd38-83da-43f6-998f-d50490de6c59",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a04531f9-26f2-4812-8e04-e43656361810",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f4fc8109-a4b3-4e26-93e7-bf656ff994f4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f2d7af4b-e645-4393-9564-3ebac685e728",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-03-25T03:17:16.7869079+00:00"
},
"company_sector_id": "b165db04-ce16-4a2c-bd86-caf454453220",
"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": "2ab2dd7e-a1ff-4b3a-812e-21e8c7e11762",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f37c77f0-4842-49a4-ad76-49a8014535ea",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f14b053a-f4a9-4b9d-9e0f-db332a19a531",
"account_manager_user_code": "sample string 56",
"company_status_id": "a0225e17-5ca2-46da-be83-9bc9fa3ac6da",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-03-25T03:17:16.7869079+00:00",
"id2": 60
},
"db_language_id": "24b26ec8-e26f-475a-b92e-3eb92b9705df",
"db_language_code": "sample string 7",
"db_title_id": "5c5134a4-7a2d-4176-93ab-a759c6b2adf6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-03-25T03:17:16.7869079+00:00",
"create_date": "2025-03-25T03:17:16.7869079+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-03-25T03:17:16.7869079+00:00"
},
"modified_dateutc": "2025-03-25T03:17:16.7869079+00:00",
"id2": 22
}