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": "dcf00ee1-b39b-4dc4-80c9-55513977cc86",
"_parent_id": "0a5da7aa-3be2-4e04-b21b-0d87a1bce418",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "138dcc32-3e74-4d9e-a9ec-e8fb1caf2ab5",
"company_id": "31e58712-dd1e-4484-bfc4-254a5cc4f223",
"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": "cde77f16-b2d1-4762-8099-0d143f0c7e8b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "bb5d182c-009b-41d1-bf61-8954a04ab458",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "d2791e9e-e84e-4ee9-b786-71692ba7c8c4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "624cc729-514b-4b30-9249-abd71f9161a1",
"company_code": "sample string 5",
"company": {
"id": "802eb18a-bac0-4478-b90f-fda8375be15e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-12-26T18:01:49.4195827+00:00",
"sales_territory_id": "e556172d-a29b-4b08-b185-bf882685c309",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fbcab3c7-646f-486c-9c8c-7309e4539736",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2d3b47c3-4a02-43e4-b4bb-38dfdb6972b8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9f69212b-3761-4329-afc4-8941ca372394",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "59f50917-3950-4356-9c89-355fe088256d",
"db_currency_id": "d0ded1e0-19fe-4760-ac0f-dae239bd7b1d",
"db_language_id": "09d79cbb-4269-4c9f-b510-3ec57a392f52",
"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-26T18:01:49.4195827+00:00"
},
"modified_dateutc": "2024-12-26T18:01:49.4195827+00:00"
},
"marketing_segment_id": "91359d5c-9ba4-4683-aa0f-f85ad47c1534",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "de88a511-0b1c-4072-8ee8-2a6aee3ddbf3",
"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": "b0c3c873-ee43-4a4c-85a2-1eb4bf03710b",
"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": "abd417c3-2017-4bcb-9270-0dc52044223a",
"db_country_code": "sample string 28",
"feelist_id": "fe471b38-139f-4d27-91a6-a523649bac6b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "eefce7f6-e3b4-42f0-816a-2977b19c2a9a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "24befd0a-3be2-4a27-8481-25eced676ed9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-12-26T18:01:49.4195827+00:00",
"db_currency_id": "6fd69c05-ee4d-41b7-b0ae-e254089a1f50",
"db_currency_code": "sample string 10"
},
"company_type_id": "6b8fdc99-ffc8-438a-a410-31b4a47fdad2",
"company_type_name": "sample string 32",
"company_type": {
"id": "08276f32-6bf7-4a3c-b0f2-f622a126b34d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2cc5a556-54a9-47c2-beec-6dc05be5b523",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3faf8d17-b673-4c78-a020-1a6579b6366d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d3287842-062a-448e-9863-5e0811a3c1d6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3defa466-36c4-475e-9983-dab6ca46195e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b8926fc6-d8b8-4e67-9d60-fedc4aceb8f1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-12-26T18:01:49.4195827+00:00"
},
"company_sector_id": "14f65d24-9317-4b7a-be11-1dcdd0a7da17",
"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": "2a79563b-ece5-4188-adac-349650fa6593",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "94774146-6096-452b-81a5-3a89a7e859a4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9654ec47-c7fd-4ba3-b467-a92be2368921",
"account_manager_user_code": "sample string 56",
"company_status_id": "8c9b01bf-def1-4225-b534-583b1001507d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-12-26T18:01:49.4195827+00:00",
"id2": 60
},
"db_language_id": "165fcfaf-2614-46ac-b7e3-8a2e64d93243",
"db_language_code": "sample string 7",
"db_title_id": "e2eca0e2-3a9f-4555-8b5f-2435517c6cfb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-12-26T18:01:49.4195827+00:00",
"create_date": "2024-12-26T18:01:49.4195827+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-26T18:01:49.4195827+00:00"
},
"modified_dateutc": "2024-12-26T18:01:49.4195827+00:00",
"id2": 22
}