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": "cad56a43-f2a5-4c7c-8d9c-a82c9b9f0b3a",
"_parent_id": "5bf6b3d1-2f48-4ba6-9052-1d1ba3fd6467",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "367d0a39-d2ca-40ae-a847-5fc52ecb5e8e",
"company_id": "a42b3b8a-19bc-4aad-8164-fe1c39324cde",
"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": "71efbfe2-330d-42ef-8efc-b8dfbd686394",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "e8888ea1-cac0-4f3c-bfd2-13d3e82cd575",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "52b5b08f-bdca-4c7c-bde7-7decc6d588f3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0c2c0b8a-ac0b-4388-9b20-55364b29bad5",
"company_code": "sample string 5",
"company": {
"id": "ba1e283d-1ee2-4526-88c5-5c8f4458c4c3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-12-19T16:42:56.5216974+00:00",
"sales_territory_id": "d2417e77-89c3-49d9-9ecd-1e6ccbd73aa4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0e0ce8dc-92bb-4215-ae56-433be7359b61",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ebaa72d7-df7a-447f-ad24-6cc110343f77",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1d3d47b5-1c8a-4d9e-97e7-d1559d41f36b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f070946-72d7-43ec-8280-945400538bfb",
"db_currency_id": "520a9671-c903-4ecb-a96c-47008aac8968",
"db_language_id": "29cfdcba-d867-4116-bb35-3b006bdf3e71",
"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-12-19T16:42:56.5216974+00:00"
},
"modified_dateutc": "2024-12-19T16:42:56.5216974+00:00"
},
"marketing_segment_id": "abcd4da7-1b88-4215-9c96-fd736e47ed31",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "299e0b37-7428-4e7d-9613-545485b111b4",
"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": "a55c8a19-2603-4cef-8e18-da6c1dc2c361",
"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": "ae7bc38f-d66d-4659-b93c-429706fb4fb3",
"db_country_code": "sample string 28",
"feelist_id": "e6ae1673-846e-47a5-970d-50eab1e88922",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "09819e7f-90c6-46d1-8ff8-c4db9ae424e4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a6d949e1-134e-47ad-b323-5cf5aac93853",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-12-19T16:42:56.5216974+00:00",
"db_currency_id": "059cb58c-4e26-417f-a29d-f38f9abfd8ed",
"db_currency_code": "sample string 10"
},
"company_type_id": "cc06aa74-dbfe-45ef-91a6-a5e4a3800d33",
"company_type_name": "sample string 32",
"company_type": {
"id": "b677f8ef-dea5-452e-b3d8-c07b44c7a2bf",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d7a0841b-2901-4c8d-a289-3169e7534d15",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5a295097-cc94-4311-bd0c-be260eb01597",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b263d309-f769-4cfe-9c48-e6e8590060ed",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e943e03c-4864-4c5d-8640-dfc8f50f3717",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ef1dbe6f-61d8-4df8-be15-3bcedb1f5412",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-12-19T16:42:56.5216974+00:00"
},
"company_sector_id": "08fb60a1-83ae-45d2-bb3c-9557dec0be1c",
"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": "9fd12782-1192-4d39-b6d0-a462ab26fbc9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5552af94-a9c2-4acf-8a75-ecbc22394f68",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d89d3bde-d14c-4753-ab15-fe714fb8dc55",
"account_manager_user_code": "sample string 56",
"company_status_id": "ad81a491-05bb-435a-b283-f8c31485246c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-12-19T16:42:56.5216974+00:00",
"id2": 60
},
"db_language_id": "57f18fc8-0d27-40f4-9fbd-7598f54b2e34",
"db_language_code": "sample string 7",
"db_title_id": "af7d91e5-3567-43a1-9ea3-77bcd64c753c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-12-19T16:42:56.5216974+00:00",
"create_date": "2024-12-19T16:42:56.5216974+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-12-19T16:42:56.5216974+00:00"
},
"modified_dateutc": "2024-12-19T16:42:56.5216974+00:00",
"id2": 22
}