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": "d3a0072e-365d-4264-b939-f5ad259aecc2",
"_parent_id": "c7e87a42-26c9-47b1-814e-f770878e340b",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "58a6c54b-cc45-4fde-9623-e0a4a52cd54e",
"company_id": "f8339d2a-dad2-4ce5-ba85-b48f77e9db99",
"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": "a092b319-17b8-44d2-b06a-85d0795b2ff3",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "0106a3ac-ffa6-42e0-ae19-4553152a5868",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "e150cdf8-7da6-428b-ae02-db2004ab6d6c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a82d274a-6939-4b73-98b4-317c7bc0fad4",
"company_code": "sample string 5",
"company": {
"id": "76c31051-5257-45a7-a9e8-c4c61a511181",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-02-19T10:14:46.1924387+00:00",
"sales_territory_id": "d10fd119-8981-40ba-895f-0710cddca327",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "91ebc9bf-46f1-40a2-9b2a-3a0fdcd9a3ee",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8c7eb2c1-60d0-42df-bb05-770abf05c75f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "79adf5af-fca2-4045-b402-a22332d6d392",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af233291-4cb6-459a-b932-73f288221089",
"db_currency_id": "329b931a-61ff-4de6-9947-a1f759289ad7",
"db_language_id": "060693d1-f9f7-4284-895e-1e88c08b383c",
"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-19T10:14:46.1924387+00:00"
},
"modified_dateutc": "2025-02-19T10:14:46.1924387+00:00"
},
"marketing_segment_id": "35aad6a3-5a1f-41e5-b5bb-e189e8219ed0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "09fd3574-5849-4f0e-8147-2d9da99edccb",
"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": "46bfe4e8-eaa6-40f1-984b-a9ea337d8b8d",
"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": "00e02cd9-bdd8-4cf6-ad14-bbd9d29b3d42",
"db_country_code": "sample string 28",
"feelist_id": "7f16de9b-6a22-4426-8b1f-f77d20afd412",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d15fcfc9-c361-42ea-8d50-03fce1fd177c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "86bb8207-f39b-4925-be9f-2551486c4f18",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-02-19T10:14:46.1924387+00:00",
"db_currency_id": "5816c3f4-75f9-4970-bad9-55aa38e6b5c5",
"db_currency_code": "sample string 10"
},
"company_type_id": "b423c589-d94a-43a7-b9f1-003ca9cca5e3",
"company_type_name": "sample string 32",
"company_type": {
"id": "8677e127-ab6a-4c7f-8d54-82c62b3cdae2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1b57537e-f9ec-40a3-aa75-ea936db92949",
"sales_organization_code": "sample string 5"
},
"db_language_id": "abcbf186-1b87-4913-b58f-c6150f9e5018",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d7753437-e59b-451a-89a1-c9461ea87370",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4c06abc5-c288-4bf7-8510-78ecb8d45dda",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3abf1980-5b8d-45ab-a75c-d07a0c5f270c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-02-19T10:14:46.1924387+00:00"
},
"company_sector_id": "718299ab-0333-4dad-8863-67aeb8c8500e",
"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": "f3705929-e5c9-4f7b-a7d6-bea056754390",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3890e1dd-45f5-4a45-b002-102e8ffbd772",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "eb396005-f7bd-469d-ab8a-bac4fe54ea9c",
"account_manager_user_code": "sample string 56",
"company_status_id": "08bcd192-d244-4afd-b6c0-28f7ee307961",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-02-19T10:14:46.1924387+00:00",
"id2": 60
},
"db_language_id": "a7729d1b-3804-45d1-9708-e0e825289486",
"db_language_code": "sample string 7",
"db_title_id": "e5d8535d-ea39-4225-a570-3a3a9b802517",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-02-19T10:14:46.1924387+00:00",
"create_date": "2025-02-19T10:14:46.1924387+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-19T10:14:46.1924387+00:00"
},
"modified_dateutc": "2025-02-19T10:14:46.1924387+00:00",
"id2": 22
}