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": "cd17f049-4674-427b-8b35-26f5326f3def",
"_parent_id": "45792f32-9074-477d-bd16-d1f77b297821",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "754d5565-6f4a-486c-8510-780ce21d56e8",
"company_id": "9e67219b-f465-4dd0-a349-a0ed32d8ab9e",
"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": "1faa9aa7-b5f1-4a0e-95e6-f40202146de0",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "a0698713-804a-4300-be7e-a2a452833d96",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "49f99b6e-71af-4946-84a8-1475d30ea56f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "37e8547a-bb11-46c6-8cdc-aad1b207630b",
"company_code": "sample string 5",
"company": {
"id": "968396eb-4921-4abf-9c7e-272633b69c8c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-04-22T01:49:24.8106915+00:00",
"sales_territory_id": "688cb005-945f-47a7-9fec-81f54385f7bc",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "43f4aa1e-62df-4c53-afc3-4222ba8a1611",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0729a5c3-0a26-4a43-adee-784627917baa",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "592d0d18-d7aa-410b-8728-b0bff3a81608",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4bbf87f1-e38f-4264-aa34-2c1eb1fc43d6",
"db_currency_id": "421b1c96-8d0d-4ebd-b9be-dfb12e0b0579",
"db_language_id": "57364546-278e-464b-984e-fccf54a1e400",
"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-22T01:49:24.8106915+00:00"
},
"modified_dateutc": "2024-04-22T01:49:24.8106915+00:00"
},
"marketing_segment_id": "437ca84e-92ea-46d5-93ae-38faea92f029",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8a392749-3c3b-4ea0-a352-f0ffcbc2d2cc",
"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": "b2dfb0e3-b87c-414c-84a0-817079aefa59",
"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": "d1a72240-9e4e-47b4-a8ab-82949cacd980",
"db_country_code": "sample string 28",
"feelist_id": "6df25e28-bd77-46ee-acf7-8948df254605",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5c2b5406-5db0-4894-af90-bf8a1ce763a1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "25e3bca6-2cc5-4343-9f20-fb70b26aae71",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-04-22T01:49:24.8106915+00:00",
"db_currency_id": "e7d01a78-ee1b-4a20-babd-dc5f2fc04d8b",
"db_currency_code": "sample string 10"
},
"company_type_id": "8e642b70-1150-4701-a2ff-ce0d5d75983f",
"company_type_name": "sample string 32",
"company_type": {
"id": "f0bff4c5-6591-4dfc-a2d4-c6232195a627",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5e546857-2409-427f-9aff-ea71e353d127",
"sales_organization_code": "sample string 5"
},
"db_language_id": "71d2aadd-e041-4e1b-83e2-2dc27962960b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "43d03733-d221-436d-8b4d-e8d0bd5cc6b9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6d95464d-dfce-4f87-9509-4495b479c373",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a84b7e6e-83c9-4bff-b058-63a7a6ad639a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-04-22T01:49:24.8106915+00:00"
},
"company_sector_id": "534cb426-9bc4-459a-a9e9-f575b9c674dd",
"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": "9df24680-b674-4c57-ab3f-e7fcc3feb41d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2cb24af2-8a84-49fc-9e9e-20940709ae6a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f1282a1b-e2c7-4c66-a6ee-9e93561c9b7e",
"account_manager_user_code": "sample string 56",
"company_status_id": "746c1ed9-f22a-4795-8ecc-182ae7d51997",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-04-22T01:49:24.8106915+00:00",
"id2": 60
},
"db_language_id": "9fbefe14-e42f-48ae-920e-d631a2b79071",
"db_language_code": "sample string 7",
"db_title_id": "072eac60-23b8-4bae-82e0-8b4f5a826ea1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-04-22T01:49:24.8106915+00:00",
"create_date": "2024-04-22T01:49:24.8106915+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-22T01:49:24.8106915+00:00"
},
"modified_dateutc": "2024-04-22T01:49:24.8106915+00:00",
"id2": 22
}