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": "2208e881-ff4e-4a91-b06b-db5a75bd8f78",
"_parent_id": "933e7d81-6ba1-4cb2-8aca-01877e7e2f53",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "1cdd823a-b0bd-43e8-97c7-bd62f8370159",
"company_id": "64900a56-695d-45fb-b1fc-0bf2eec64871",
"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": "6d11a12d-5a76-4cc2-9390-4c4c9153c4d9",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "33306d54-c91e-4ed8-96a3-4be1068b4557",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "b6b0dbee-2d57-4952-9cd8-cc115e8e112d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f8d714bc-3a16-48c5-9713-eae5ac6e69b5",
"company_code": "sample string 5",
"company": {
"id": "99566cdb-ebd4-4098-98da-ec649baf088e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-04-16T22:10:28.9707913+00:00",
"sales_territory_id": "48feb126-5143-4efc-892d-46080aa79a83",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ca430a4a-dd49-4382-aa47-95bf5f92398d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "81cd54d0-f9f2-48a8-8a34-83a1e5f7752b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cca314c8-a10d-4d02-af97-0daf0e802f03",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40fe30a9-51e3-44eb-8cb9-8a09a4e50d47",
"db_currency_id": "89578059-0bc4-4874-8afc-b161a3d33429",
"db_language_id": "2344334a-eed9-4032-b8b6-5853d85a4373",
"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": "2024-04-16T22:10:28.9707913+00:00"
},
"modified_dateutc": "2024-04-16T22:10:28.9707913+00:00"
},
"marketing_segment_id": "fa8f39a2-5e45-4e87-b35a-3c1148f488d0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "11d54a73-fd1c-4184-b056-1a66ccdb6128",
"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": "1b7f4237-340b-4c33-852c-9a36d70f78a6",
"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": "a2fe47cc-b57f-4ab6-8ee5-df891975c3a2",
"db_country_code": "sample string 28",
"feelist_id": "4a6a9fb4-123b-4a0e-8207-798d92b10ea0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "53d24e5b-c0f5-449a-ab44-2d311934266f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ae23d12a-8fc1-4d22-abe4-6718e2ebbf48",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-04-16T22:10:28.9707913+00:00",
"db_currency_id": "81778060-5bfc-455f-94b5-e7883cb216e0",
"db_currency_code": "sample string 10"
},
"company_type_id": "e1a42532-1dc6-443d-9e93-9c9c4a6f836c",
"company_type_name": "sample string 32",
"company_type": {
"id": "21a94076-54ee-4571-b7d2-c4e1b1fe60c6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "46efd068-86bc-4855-ad25-bbd7972b2c29",
"sales_organization_code": "sample string 5"
},
"db_language_id": "dee8595b-0b92-41f5-8431-c503749edb8d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3717de51-f6bc-4aa8-922c-b1edaa051f59",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d1c9629a-6aca-4f1b-bcab-f049c6cbaccc",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6ee4d2e5-93cf-4958-b933-691438941f80",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-04-16T22:10:28.9707913+00:00"
},
"company_sector_id": "dee384bf-80de-4e67-9270-ebbfc6f1f08e",
"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": "65dfe07b-9329-4cf3-b4b3-138dbfa64250",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e4d07c3e-bec6-4660-9d50-854cf22c5094",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "dcdbc22c-83d5-4c37-98b7-77dce9514c11",
"account_manager_user_code": "sample string 56",
"company_status_id": "487a8e27-b8bb-4a47-9601-2f8350320176",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-04-16T22:10:28.9707913+00:00",
"id2": 60
},
"db_language_id": "c11ad92c-60de-4b91-abd5-a4da5c4af2e3",
"db_language_code": "sample string 7",
"db_title_id": "63d13ab8-9232-4897-a11f-338052b6c304",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-04-16T22:10:28.9707913+00:00",
"create_date": "2024-04-16T22:10:28.9707913+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": "2024-04-16T22:10:28.9707913+00:00"
},
"modified_dateutc": "2024-04-16T22:10:28.9707913+00:00",
"id2": 22
}