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": "45269302-c77b-4b29-8ebf-fba500319ca4",
"_parent_id": "98fa8d59-1a00-4136-a69a-9943aa674717",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "cd0ed557-4657-4bfe-81b3-85b711c93f24",
"company_id": "6fafd304-4a74-48a0-9483-47f4f9fc5fdd",
"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": "1711772a-7118-4b96-8fbb-dff58e751212",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "08e31dcc-8062-445e-a5f5-cca59286de8b",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "606b15d5-e55a-4b4d-b59f-46978cd044b9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7e9266b2-8311-498b-a517-331cee87840c",
"company_code": "sample string 5",
"company": {
"id": "29a9d569-6c00-4489-a511-43f8a0ab8227",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2023-03-20T20:49:01.8971325+00:00",
"sales_territory_id": "aeecbde0-21fb-48d7-8448-edc4cf2567ed",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2cae2df2-8f63-45bf-a4ac-7bc1f2856359",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "81203be7-6819-4a36-9dca-8465e2953261",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9a14725e-dbf7-4f84-83e6-207a3bf7f69c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0b3f276a-e679-4a7c-87d7-560cf824ed0a",
"db_currency_id": "88007364-1867-4c93-8869-57482b908ad2",
"db_language_id": "1b3b1032-8e47-47a1-8c1b-4d5b579db1dd",
"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": "2023-03-20T20:49:01.8971325+00:00"
},
"modified_dateutc": "2023-03-20T20:49:01.8971325+00:00"
},
"marketing_segment_id": "11dc693f-84c1-4244-9dcd-1e760e3d38ec",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "af79e100-8683-431c-a3e3-3279ccda8dd9",
"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": "03d75e0f-53cf-4abc-b366-58bb10c87b4c",
"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": "b3c3f362-153a-45bf-a87f-a0da3ab3691a",
"db_country_code": "sample string 28",
"feelist_id": "84a11c80-02eb-470e-b724-2432adf126c3",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a7e06154-8990-4fa1-8dcd-3ac28bc7500a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "914c6309-2096-4885-a8bf-35c9bf70455e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2023-03-20T20:49:01.8971325+00:00"
},
"company_type_id": "13d1f801-f4a3-462b-ae9a-c6e8cbdd0a19",
"company_type_name": "sample string 32",
"company_type": {
"id": "ae9a0860-00e5-41d1-9044-671bdae67d60",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dfb97f98-82c2-4aba-93e5-efa54255b814",
"sales_organization_code": "sample string 5"
},
"db_language_id": "631f7639-3cc5-4a5d-853e-b529620ce954",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1e8f7778-9582-4b85-a5ed-8c444ae96385",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e0c5446e-10a0-4cb1-a85c-bb6533a03f0c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3b3e5b2d-8f39-44f8-b22f-97f5088bc941",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2023-03-20T20:49:01.8971325+00:00"
},
"company_sector_id": "5fc36582-3e5d-47d5-beb1-70bd77cf1627",
"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": "94b32892-d9d1-4bf3-b023-3bf2cc3f6eb4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6d662cbd-d6bb-4adc-a84f-9b1631111837",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a3b8b263-ceeb-4b50-ab54-cec7d6803775",
"account_manager_user_code": "sample string 56",
"company_status_id": "84f58e01-dad8-4e9c-84e2-f7af4d088472",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2023-03-20T20:49:01.8971325+00:00",
"id2": 60
},
"db_language_id": "fe244a2f-5543-4391-8e40-22142f790027",
"db_language_code": "sample string 7",
"db_title_id": "e103e04f-5146-45ee-855e-a42867184bd4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2023-03-20T20:49:01.8971325+00:00",
"create_date": "2023-03-20T20:49:01.8971325+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": "2023-03-20T20:49:01.8971325+00:00"
},
"modified_dateutc": "2023-03-20T20:49:01.8971325+00:00",
"id2": 22
}