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": "5ebad38d-fdb8-494f-8d56-bee04952b97f",
"_parent_id": "ad662494-b069-473f-b7c0-96e5d9325ee7",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "9ea95a6f-f9d4-43b2-b7ea-ed8872393ede",
"company_id": "a6338722-cc89-4d39-8ddc-8cf032fcbb6a",
"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": "0ebc1124-5bd4-4ccd-b083-e124f3c7e4c4",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "0e09d08c-7f80-42af-955d-da2e510a6ef6",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "5023acdf-b038-43dd-9423-24c1d1313941",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "67fc2d64-662c-4921-adda-481189ed92e1",
"company_code": "sample string 5",
"company": {
"id": "6194c9c1-937f-4afb-b094-825d96a0d025",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-16T00:46:34.1110227+00:00",
"sales_territory_id": "8a9d074c-5329-46a6-9d27-a635da25ec94",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7d2e9af7-bd07-4f43-bd7d-b46a5d887848",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9886c24f-f9ca-4709-8cd1-a4b74f0af03b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4d1a81e0-5215-4420-9dce-601535e43b02",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe01d8d4-78da-44f7-8e2f-2ddbf209ca3b",
"db_currency_id": "1047dbf4-40db-4aa2-9360-c81f5b08cbae",
"db_language_id": "abe41cc6-261f-471b-b7ad-7d0900c6fbb2",
"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-05-16T00:46:34.1110227+00:00"
},
"modified_dateutc": "2025-05-16T00:46:34.1110227+00:00"
},
"marketing_segment_id": "6889932b-c3e1-4daa-b8d0-cc58288e6f07",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5f24e9bb-86c5-41cd-ab3e-7db6ff1b7a63",
"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": "674d0fa8-4d78-4da3-ba66-0b8837bf6805",
"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": "81c706e7-64d8-4576-9173-b274c1a13526",
"db_country_code": "sample string 28",
"feelist_id": "b8fbbfa8-927e-42da-8155-d37e565b178f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "71b05ba3-68bf-4683-a276-1c93426f239e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "51e36deb-57d9-4fd5-a1da-75598791ebef",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-16T00:46:34.1110227+00:00",
"db_currency_id": "e2425f39-2487-422e-9cc6-0c73d83748d9",
"db_currency_code": "sample string 10"
},
"company_type_id": "ecc8a28d-c4c5-4b33-add6-29cc49591698",
"company_type_name": "sample string 32",
"company_type": {
"id": "d4002e0c-380c-43ec-bc54-aa09f491de5c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8438e5ae-8133-400f-aaa6-1c6c154e0e6e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "55e478d4-72d2-4a1e-8e6a-983a8ed87376",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "27f3be30-dcf3-4522-b624-f00120f78238",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0697b7c6-a9a2-4597-b352-ac2a60d75a5d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8abbc89e-d81c-4206-88ba-d7823c922a25",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-16T00:46:34.1110227+00:00"
},
"company_sector_id": "6b4f3fc8-ec8b-4d38-b9ad-a06944e627bb",
"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": "46dffac3-481c-4025-a466-cc57eee56fb0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d1aeab7e-da4d-45d0-987f-c66f5e7aa073",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "76cb0497-3587-4a59-abaa-b33815562851",
"account_manager_user_code": "sample string 56",
"company_status_id": "c72184c3-a801-4131-8f4b-0d62d9c22fc3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-16T00:46:34.1110227+00:00",
"id2": 60
},
"db_language_id": "28e1b459-44d7-44c7-86e7-2b62f54b58f6",
"db_language_code": "sample string 7",
"db_title_id": "941e3816-5dfb-47ba-98c6-960afca1e1c6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-16T00:46:34.1110227+00:00",
"create_date": "2025-05-16T00:46:34.1110227+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-05-16T00:46:34.1110227+00:00"
},
"modified_dateutc": "2025-05-16T00:46:34.1110227+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": "26061800-9489-4830-a77e-db8abd4f681b",
"_parent_id": "07e44d72-8425-469b-acd8-aff097f59dd0",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "19a982b0-abb4-4152-882b-f9957ab7f517",
"company_id": "1b02e212-71c9-4aaa-baea-e308abfb8a61",
"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": "a7fa7872-274b-4bb9-872c-2e90db286cea",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "14e67b46-0b84-4cad-a462-7f8942eac00b",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "4c0b8b83-6f9e-4bdb-be41-f707980f4c27",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "595219a3-2f11-49b6-b98b-855d63a14e7d",
"company_code": "sample string 5",
"company": {
"id": "a39f79e0-9d48-419b-85bc-69a6f8d54589",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-16T00:46:34.1578987+00:00",
"sales_territory_id": "c2e8cf5b-e17d-4c3d-9dad-99cf86e20606",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b00dedf0-9806-4f7e-aa79-0dd379cad0c6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "127cab32-8dbf-4c2f-82c6-6592e5e2d483",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e1128ca8-30fe-4700-9511-83a0f0e13543",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a5ebc974-dc4c-4d4b-891a-7f2bb0364fb2",
"db_currency_id": "5ec32fef-511c-4647-81b4-818d7e489384",
"db_language_id": "fac8d27a-6510-49bf-a065-d9cd503ebd02",
"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-05-16T00:46:34.1578987+00:00"
},
"modified_dateutc": "2025-05-16T00:46:34.1578987+00:00"
},
"marketing_segment_id": "59b00d69-8def-4f41-93e9-14b3b279b2d0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a04fdcb8-6f96-46c6-8d45-6eb7e0c727fe",
"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": "25941a8c-0698-4093-8d8e-c97eeca621ff",
"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": "c694bcea-c214-451c-948c-ae7239a7ada3",
"db_country_code": "sample string 28",
"feelist_id": "7789c08c-9f76-4ca0-8777-d2fe6fb0e536",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "dcb5be10-6af4-411a-b235-d07a2553c502",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "04a25c3a-e464-4b2c-aff1-230e5bf99f8c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-16T00:46:34.1578987+00:00",
"db_currency_id": "3f5f2b6e-3664-4d45-a1cb-51e2d5891094",
"db_currency_code": "sample string 10"
},
"company_type_id": "0392365c-5189-46c7-bc35-24b842279b19",
"company_type_name": "sample string 32",
"company_type": {
"id": "0d988fbe-0e8c-418b-9a86-851e1c384296",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d4f32786-6b66-48fb-9e03-06813b95c6f5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "39f2a064-687a-4e57-9191-dd27985d8311",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "62f06991-a93e-4084-b96a-231a5dd1ccd1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d3fce1a1-cb79-4e4e-8443-c92885adfd48",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "84498007-4937-4915-bc5d-10aae9c75c86",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-16T00:46:34.1578987+00:00"
},
"company_sector_id": "cba7a343-1d4c-475a-ac11-12938eaf9b1f",
"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": "5dcdd73d-5944-48ac-a4d0-d89f72f35e34",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0f77e170-990f-44da-8670-e870242aae44",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c756d3ac-5e7d-4bdc-84ed-a22263300a58",
"account_manager_user_code": "sample string 56",
"company_status_id": "cf6b1b90-d3ed-4d86-99ae-414b9a6686c3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-16T00:46:34.1578987+00:00",
"id2": 60
},
"db_language_id": "3d6d0e74-aeb3-45bf-812a-2c6cf9a48542",
"db_language_code": "sample string 7",
"db_title_id": "693d5a0b-c28c-4c25-ac8f-4a0d21749aca",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-16T00:46:34.1578987+00:00",
"create_date": "2025-05-16T00:46:34.1578987+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-05-16T00:46:34.1578987+00:00"
},
"modified_dateutc": "2025-05-16T00:46:34.1578987+00:00",
"id2": 22
}