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": "e170a837-76a6-4015-86ea-e5168db9650f",
"_parent_id": "0d050858-9f73-49ee-a7a3-be6023f9a67e",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "738cb29b-3b79-4473-978b-4decf794eeae",
"company_id": "19d74c95-36f8-4fe1-9906-1b588bb84251",
"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": "ba926a18-bddb-4b36-86c0-2380bb528f5c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "da0215ed-0403-4708-bb03-0e8c128267ec",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "0a8328f9-57ae-4bf6-8a02-07e5e79edd4f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a9b42feb-035b-4adf-8940-7e883e446d23",
"company_code": "sample string 5",
"company": {
"id": "c5fb25d6-6adf-4302-95a7-c342089cc4fb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-11-21T08:35:15.4053233+00:00",
"sales_territory_id": "39b51dd3-d36e-4d92-9333-9b269262ef24",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "73bc2746-b584-40b6-82e9-2dc39854075e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "30fecf37-6728-47e2-908d-26a33a081f1b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ec724708-8690-47e5-b4d8-337c32acd9da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8170cb8b-ebac-4ac3-9652-6d473432914c",
"db_currency_id": "1c21cba7-bcf9-464c-95af-cea843f4ddfa",
"db_language_id": "91c2861b-dc0e-4c99-820a-fa3942a4ef15",
"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-11-21T08:35:15.4053233+00:00"
},
"modified_dateutc": "2024-11-21T08:35:15.4053233+00:00"
},
"marketing_segment_id": "7ec5fab5-e2b3-4098-a037-b2852d4a9be1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "af6d19b4-f5a8-4236-a3eb-6fc06ae6e0a4",
"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": "dfe96ccd-c4c2-4346-b2e6-ea85c4e30a01",
"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": "9fa4dd34-df36-4fed-af17-62dccbb24864",
"db_country_code": "sample string 28",
"feelist_id": "8b98dc5a-9a22-465d-93c2-8eaaa3863187",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "634fff13-c690-4bf6-8901-b852c79c6807",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "05d6cef9-c17b-4cf2-9944-bf0209005a67",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-11-21T08:35:15.4053233+00:00",
"db_currency_id": "f0b5606e-1062-4d3f-9e89-640f8c73fbce",
"db_currency_code": "sample string 10"
},
"company_type_id": "c5ab6189-39dd-408c-9b1d-e094a0b59648",
"company_type_name": "sample string 32",
"company_type": {
"id": "b044d564-7b93-45ee-acbc-6106ed1a4f8d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "88af6d06-ba43-40d9-9d59-a091287dfb76",
"sales_organization_code": "sample string 5"
},
"db_language_id": "961a2a90-3cf8-4630-a923-4570a9188dcb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f36016fa-cd10-4e80-adbb-216e32ddefb6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "804e5d3b-b118-4fb1-94d7-e29a1841e497",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c7989008-8662-4b02-80ec-44a8b5e42061",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-11-21T08:35:15.4053233+00:00"
},
"company_sector_id": "15a16302-21a5-4594-a3f0-71681543e13f",
"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": "06ea68bc-7ae7-48d0-a18f-8396b4053e91",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ce08570c-a9bf-4167-b278-d4e2449410bf",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "246d5a42-70bc-4ee7-a233-9225562ad2be",
"account_manager_user_code": "sample string 56",
"company_status_id": "f96b1c7a-a099-413b-a94f-98de79ab6daf",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-11-21T08:35:15.4053233+00:00",
"id2": 60
},
"db_language_id": "34cf36dd-c4f8-4821-a43c-f21b20904b77",
"db_language_code": "sample string 7",
"db_title_id": "6059e393-9df3-4e35-bbf7-2fef63eb7163",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-11-21T08:35:15.4053233+00:00",
"create_date": "2024-11-21T08:35:15.4053233+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-11-21T08:35:15.4053233+00:00"
},
"modified_dateutc": "2024-11-21T08:35:15.4053233+00:00",
"id2": 22
}