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": "71342b7a-ca69-477c-b0f7-7f65315634a9",
"_parent_id": "68509497-3615-4279-a7f3-7c9bfc4dc77f",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "2dfa7c34-db45-4e93-930c-3fd23081bcfb",
"company_id": "2a692f19-0c2f-42d3-9659-575f4e0e42a2",
"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": "98d690a2-c09b-4d65-a47c-de58e9f2a07c",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "8d22ef46-88c4-4bac-b587-76900a3fa1dd",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "073b152a-2c10-4291-afcc-9df9999672cf",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "eb3f6e1f-1794-44b3-8ed6-ae76fc6e7cf0",
"company_code": "sample string 5",
"company": {
"id": "bbf39048-394b-4634-85ff-4b034ad7c208",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2024-04-26T15:32:01.2374207+00:00",
"sales_territory_id": "4ff74c67-a41d-4b41-84d1-46aa4fd20f3c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "616114e9-c68e-44b6-bd06-bfcd3e990745",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b95ec3ef-24f4-4759-ac0e-afa78d0b91ce",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9fd9f548-a306-4290-a629-6db52a2b0d76",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d8ed4409-8d10-4a9a-ac76-0981231fdd04",
"db_currency_id": "4f0483ca-e708-4501-9d63-e78187827c98",
"db_language_id": "c9aac092-cef4-454b-a6f6-b304c2e11f67",
"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-26T15:32:01.2374207+00:00"
},
"modified_dateutc": "2024-04-26T15:32:01.2374207+00:00"
},
"marketing_segment_id": "c2b6f353-8918-4449-b68d-419d96160571",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9306f001-9244-4e3d-b1f1-4ffcaca0aa82",
"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": "ab91a526-d654-4f81-bb99-ab4987cbde0b",
"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": "8f71a2b8-1efb-489a-9845-9d4e571c3dda",
"db_country_code": "sample string 28",
"feelist_id": "4742edd5-8b61-4678-8d6d-77bec3e86256",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fed533a6-5858-429c-a485-04f63d8959c8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "773c1a34-4849-45cc-a1d3-3f3022a8a923",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2024-04-26T15:32:01.2374207+00:00",
"db_currency_id": "848a254e-554f-4c5f-8930-cfbe0166f322",
"db_currency_code": "sample string 10"
},
"company_type_id": "a2507566-b7ef-4315-8ec5-82f504bc8e9d",
"company_type_name": "sample string 32",
"company_type": {
"id": "e7e7415b-67c5-4ebb-a27e-f7409d12ebc7",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9f8bc959-6444-478f-92ce-81f581245d64",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e619d6bf-cc6a-4c9f-8111-a33fd6d2565f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3a5550ac-a2d2-4d29-973d-27a11bccc465",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fb73bdce-31f3-4e23-8247-0d57c4f13e79",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "45611e79-136c-4cb9-a5d1-5889cf0c9951",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2024-04-26T15:32:01.2374207+00:00"
},
"company_sector_id": "02f11fa7-1209-40e4-a3be-06efaa495114",
"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": "5097d77a-bc1d-48cf-9427-2f7519d58431",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5ce39a84-7de8-41d1-bea5-4962b405f0b2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "752cddb5-6c0c-4a11-9636-c9ceeb28bb74",
"account_manager_user_code": "sample string 56",
"company_status_id": "7347491c-e246-4737-af20-9d3c952ab1a4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2024-04-26T15:32:01.2374207+00:00",
"id2": 60
},
"db_language_id": "6e044532-72c5-4706-9fa3-6ddd0e26705f",
"db_language_code": "sample string 7",
"db_title_id": "41943808-17dc-413a-ba26-edaacf2e5af5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2024-04-26T15:32:01.2374207+00:00",
"create_date": "2024-04-26T15:32:01.2374207+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-26T15:32:01.2374207+00:00"
},
"modified_dateutc": "2024-04-26T15:32:01.2374207+00:00",
"id2": 22
}