Creates a new location object
Request Information
URI Parameters :
None.
Body Parameters :
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 |
Request Formats :
application/json, text/json
Sample:
{
"id": "dd1d233f-af05-4bdc-8dd8-2298f7e0f01c",
"_parent_id": "c6c8b92b-b90f-4110-80ab-180562298665",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "6dbb9c1a-ff35-400f-823c-df85fd2818f5",
"company_id": "df94dd87-c936-477f-a05d-ab0d718d0475",
"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": "1b95ab78-01b5-4586-89a1-45a91e9ed88b",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "eacce1e5-b325-4e19-ae2c-fffc0c32c503",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "799067b4-a3d7-4855-b712-4d097d9e534f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "786b8752-23f4-4c79-8560-76009b33380a",
"company_code": "sample string 5",
"company": {
"id": "429ace22-b00d-474d-89ae-03e11c6e0d90",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-25T23:28:18.8048001+00:00",
"sales_territory_id": "8a34c865-08f4-4b4f-a579-7bdc7197b3cd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9258c924-9330-4179-8174-bdd25833d345",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ba611e4f-b8be-46d8-b74c-9147e74fb148",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a0adefa1-7bf0-4a61-947b-b9647ff072d9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b0dcd7e-b2d9-4196-892d-dc0a56328428",
"db_currency_id": "0fd1ae07-1634-4ba3-8a1e-c1d575be1ea2",
"db_language_id": "fdaeb6c1-c02a-4e25-8cb6-ed36ac7924aa",
"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-04-25T23:28:18.8048001+00:00"
},
"modified_dateutc": "2025-04-25T23:28:18.8048001+00:00"
},
"marketing_segment_id": "dd6b47e4-5a0e-498b-ac84-f3c2ddb3b457",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bbdccc7e-3546-4695-b74f-5f99d61afb1f",
"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": "19044cc6-8cd2-47e6-bfcf-620b4ef73a7d",
"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": "8db28909-f114-4dec-b2e6-de951670e62c",
"db_country_code": "sample string 28",
"feelist_id": "7cc5425d-aa9f-423e-a6d3-d4bb7a4112a1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "19c7f1f3-bc2f-41e1-9e8b-34746a8b501d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e063f611-5763-42f3-9bc7-40c58800ac00",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-25T23:28:18.8048001+00:00",
"db_currency_id": "25818dfa-238d-4a7f-85ad-a36ff99bf853",
"db_currency_code": "sample string 10"
},
"company_type_id": "2fe402fa-9b9b-4a98-af1f-4bf883df6823",
"company_type_name": "sample string 32",
"company_type": {
"id": "50aa40ce-40d5-430c-9c78-a238867adbd3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "25d22514-546d-4899-8783-8a96fbaa2e06",
"sales_organization_code": "sample string 5"
},
"db_language_id": "11a2601c-4680-4e26-b2aa-e0aa9b943b44",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "365dc604-7c96-49b8-9a77-912a8660619f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a01ea61d-c82f-4dec-907b-51b41c3974cb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2ad97e29-554b-475c-ae39-8a362fbaced4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-25T23:28:18.8048001+00:00"
},
"company_sector_id": "296f8c48-570c-428e-97d3-2d3f33a686fc",
"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": "bb70b70f-80a5-4dd1-ac3e-75863bead590",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "14bcb585-9650-4b41-857c-b95273088e92",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "52c17487-f10e-4de3-8298-dc8ba79d456f",
"account_manager_user_code": "sample string 56",
"company_status_id": "a2e26c00-669b-4877-b4e6-edac41f5efd6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-25T23:28:18.8048001+00:00",
"id2": 60
},
"db_language_id": "fb793e33-0e6a-4366-bcde-498ef47d580f",
"db_language_code": "sample string 7",
"db_title_id": "b796f460-3953-4b08-af43-169b55eaa2fb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-25T23:28:18.8048001+00:00",
"create_date": "2025-04-25T23:28:18.8048001+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-04-25T23:28:18.8048001+00:00"
},
"modified_dateutc": "2025-04-25T23:28:18.8048001+00:00",
"id2": 22
}
Response Information
Resource Description :
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": "adff7295-0ef5-4016-a9d4-ee6b5630f929",
"_parent_id": "81bc6333-5928-4d30-b7c6-f74e9957fe3c",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9243f017-72d8-45f8-939a-7415eeee0402",
"company_id": "6205e115-16af-4a81-a4fd-98cfe85909dd",
"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": "069b135f-8b0d-44a3-912d-f69ade1132fe",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "83bfa6d6-2041-4937-bff6-97b43121bb89",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "972ddaf0-1fdd-4328-8e73-0e6c207f46fe",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6847be1f-646f-4c96-8b35-e89553eec4c0",
"company_code": "sample string 5",
"company": {
"id": "6bba268a-9729-43a7-a75f-37f59887b033",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-25T23:28:18.8048001+00:00",
"sales_territory_id": "89d1e450-4ca1-465e-b767-8c80d1888a7e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d946799b-d1e9-431d-9102-02459a3840fb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9e59d5ab-9f85-451f-a803-4f41a20c0c94",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5ebb1682-d69d-49e2-952b-9d7ac543ab44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dd7736a0-13ee-463f-a2bb-aabefead5aab",
"db_currency_id": "118d52b3-74ed-4473-a663-7e4cdeec3ab7",
"db_language_id": "7be1face-e157-4ee1-832c-b73b194f8c53",
"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-04-25T23:28:18.8048001+00:00"
},
"modified_dateutc": "2025-04-25T23:28:18.8048001+00:00"
},
"marketing_segment_id": "8573d755-6af8-44d9-b1c0-7407fb10d406",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6abde70e-48af-48d2-a3ad-e6df198dcdbb",
"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": "c51e61d2-8416-4ea3-8c1d-0e0803bb030d",
"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": "41462991-5e87-4ac6-90b5-1e92428f8833",
"db_country_code": "sample string 28",
"feelist_id": "06c92c14-9d8d-4b8e-a72c-b73e968f627d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "54dfe7c2-532d-4fc8-81ef-21bb853e7e5f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c49c4b09-6bc2-4faf-87a2-5c9fb66dbd8a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-25T23:28:18.8048001+00:00",
"db_currency_id": "6ca87e69-f456-4afb-9fad-ed253831f935",
"db_currency_code": "sample string 10"
},
"company_type_id": "b8cdf766-0adf-4032-9339-e6aeec755908",
"company_type_name": "sample string 32",
"company_type": {
"id": "d3de30cf-911e-4166-a536-b43ae19494a8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "63b631b5-ac4d-4e11-8b48-d1056ecfcc8e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ec255499-5744-451e-a851-224638f28f2b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1b6ac558-1419-4457-9ce3-b06023d42368",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b00dd2fe-ab30-424a-b881-dc86eae44741",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d5eebb92-cde6-4bbc-a275-b39d7a08f61c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-25T23:28:18.8048001+00:00"
},
"company_sector_id": "29a362c5-7575-4ca5-a8c0-be4bd03afcbe",
"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": "9424099d-81f0-4bac-8542-ff5e99c69c5d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4e2ef5ba-35de-4b0c-9d26-2d946d583b64",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "42dd484e-2993-4b00-a867-2b6407c8bd51",
"account_manager_user_code": "sample string 56",
"company_status_id": "f77dc856-c685-428f-8fb9-5bb77f735c1a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-25T23:28:18.8048001+00:00",
"id2": 60
},
"db_language_id": "e5fc1426-1a0c-4114-8a7e-378115cb460f",
"db_language_code": "sample string 7",
"db_title_id": "14e20018-d426-4c07-91cb-5fc49829b9b6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-25T23:28:18.8048001+00:00",
"create_date": "2025-04-25T23:28:18.8048001+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-04-25T23:28:18.8048001+00:00"
},
"modified_dateutc": "2025-04-25T23:28:18.8048001+00:00",
"id2": 22
}