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": "2e983484-a510-4b6e-82cb-dd8993c3864b",
"_parent_id": "89f2cb3e-fcf2-4f67-a9e2-472aada040a2",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "17b82238-33b0-42be-a396-f6d3b1b7b4df",
"company_id": "7027c210-c93b-46a5-971c-ea573e847f57",
"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": "6ccc6fd7-4238-4cba-81d8-a980b2153d71",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "f837c946-9b27-4f32-8ca9-9f94056a4362",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "22c4543d-90f7-428e-8c8b-d4839ef10b82",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e19b8caa-d118-4edf-9900-0d0c8afadd1d",
"company_code": "sample string 5",
"company": {
"id": "0ecd40c0-869d-44ce-a168-ebdc1ee50fa9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-13T02:49:22.021913+00:00",
"sales_territory_id": "c5653881-c9a3-4cee-a8f0-406c4d4be175",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8d5c2125-39e8-441e-a8cd-770028b19e9e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "78363c81-2ac4-4380-9e81-7da6e747c528",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9a83c49b-d692-4866-9676-05e4dc16c20b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35fffd65-9bc6-4100-9224-fc2713576b8a",
"db_currency_id": "e4b67c02-e1c9-434f-b30b-93e4bb20f17c",
"db_language_id": "e4dd5f6e-c8de-418b-a724-85c265a31070",
"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": "2026-08-13T02:49:22.021913+00:00"
},
"modified_dateutc": "2026-08-13T02:49:22.021913+00:00"
},
"marketing_segment_id": "a2e12307-1547-4a23-8a7c-e4eb1a01ff0f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ec52e7ca-1f6a-4ed2-a927-f4f5b678b780",
"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": "f4947fa9-8700-4057-99fd-d5d541e0ee8f",
"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": "09df0ac1-9e6f-4677-9d8c-19e7bfff96be",
"db_country_code": "sample string 28",
"feelist_id": "d57ac1d2-cbf4-4ff1-ab5a-20cce56e80ec",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "04f9e6f6-b5c2-477d-a2eb-15ef2081b714",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2e7dd530-ddc8-4c82-92cc-9420c22c2f1c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-13T02:49:22.021913+00:00",
"db_currency_id": "761ace90-a345-49ef-b655-59b358008031",
"db_currency_code": "sample string 10"
},
"company_type_id": "87ccc650-fa02-4be4-bc7f-de948482f2f3",
"company_type_name": "sample string 32",
"company_type": {
"id": "b4acdc4d-0ef1-4250-af7e-b6651fd9a1a1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "219c9803-1a0b-4f21-9339-129759a4ddd9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e97f04d4-b926-4d1d-8ffa-1ef1696ee821",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ac6541be-791d-499f-b28b-5cb12468de62",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fe04b73d-acda-40e8-b7ff-81393f08f756",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "43a4ecc8-75ea-4873-83ba-e75d871cd050",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-13T02:49:22.021913+00:00"
},
"company_sector_id": "65c1d263-2437-444d-992b-f82aedcdc526",
"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": "9b3a0c5d-8dc1-4b4d-a3ea-10a661e4780f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "04dce8e8-56db-4dc4-9216-ac1ffc0a6b29",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5fb214f0-b7f1-450a-81b6-fcb86920b02a",
"account_manager_user_code": "sample string 56",
"company_status_id": "18b42c98-e3e2-4e2b-ab24-8edf32bc7b91",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-13T02:49:22.021913+00:00",
"id2": 60
},
"db_language_id": "d7db3acc-9222-4604-a911-f0c420a2ab16",
"db_language_code": "sample string 7",
"db_title_id": "724028b0-6fa6-427b-b126-66885b560486",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-13T02:49:22.021913+00:00",
"create_date": "2026-08-13T02:49:22.021913+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": "2026-08-13T02:49:22.021913+00:00"
},
"modified_dateutc": "2026-08-13T02:49:22.021913+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": "ba04c8ea-9b69-4f5f-9eb0-1ed149c1e538",
"_parent_id": "e6f10841-72e0-4696-84c0-af0a12697706",
"_parent_reference_back_office": "sample string 3",
"project_status_id": "7d9536c0-234a-492f-b2e5-7d1dd80c4ba0",
"company_id": "6ab2b8fe-9c96-4f44-abeb-a5a30a412e20",
"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": "1788a938-8d9a-46b3-a4d9-229aa0ea21d2",
"db_country_code": "sample string 17",
"street2": "sample string 18",
"latitude_decimal": 1.0,
"longitude_decimal": 1.0,
"contact_id": "9df3a58f-3f8e-4a89-b95d-f6e2ba785285",
"contact_reference_back_office": "sample string 20",
"contact": {
"id": "2e5b6106-5091-4d64-a24b-72a2bb3c298f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "689c6c14-b82a-4f8f-94c0-b826a2574377",
"company_code": "sample string 5",
"company": {
"id": "4948ef7a-fecf-49be-bb83-36131b381217",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-13T02:49:22.021913+00:00",
"sales_territory_id": "d32526ad-d554-4ca0-8a21-afb208eafdbd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9185c6de-7712-4c1e-ae92-f445b9e49b8d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "983a73a4-9576-4b8a-af35-eb1bbfa3ad16",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4c1f864a-464d-43af-94ef-7e0e25dc78e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbc25a44-28fc-4857-880a-69e6d2d6d150",
"db_currency_id": "3dbac75d-0525-456f-b6a3-eaa4ee865210",
"db_language_id": "975d10b4-184a-488a-87bd-f83c2af2bb72",
"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": "2026-08-13T02:49:22.021913+00:00"
},
"modified_dateutc": "2026-08-13T02:49:22.021913+00:00"
},
"marketing_segment_id": "ecd29259-fff1-438e-83a6-bd5c00222783",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5bbaeaac-0112-41e1-9ea6-728cb9709c92",
"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": "d6f89bec-8274-4a75-aa64-d71f21b1e052",
"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": "16e91c9f-4f15-4e6b-bdb1-61b982de0046",
"db_country_code": "sample string 28",
"feelist_id": "963a587f-ffa9-42ef-9054-0d6054f67f25",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "da759bde-dc12-4913-b8e6-2afd86872cc2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ba175e07-ebc2-4074-af44-4712f8d08a73",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-13T02:49:22.021913+00:00",
"db_currency_id": "857d648e-faa4-4006-be44-dcb78d99b0ab",
"db_currency_code": "sample string 10"
},
"company_type_id": "f5aa1161-c765-4f58-b40e-1098ec9d9b06",
"company_type_name": "sample string 32",
"company_type": {
"id": "4adfe13a-7cb7-4574-8074-0c958640f421",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fe679134-d49f-477f-ae42-376e277a2532",
"sales_organization_code": "sample string 5"
},
"db_language_id": "83e454c1-e32f-4b28-9ea0-e8bb7ce9d738",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6a253e5d-04b3-46dc-9f2a-37a82fc6c99f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1faa8a70-1994-4053-9f63-920ae08334e0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8b4c2995-158c-4322-a791-eab61f8c2abc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-13T02:49:22.021913+00:00"
},
"company_sector_id": "a6ae9649-be5f-4d10-bc93-212c97a28507",
"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": "d0d48aee-5b5c-4345-b022-6cccee210b2d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "18c650ea-c615-46ff-9e90-32a7d60f21c4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7a5a4232-9096-4bfc-a05b-612005a30434",
"account_manager_user_code": "sample string 56",
"company_status_id": "5969ff24-fbc3-488f-940b-f495df81741e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-13T02:49:22.021913+00:00",
"id2": 60
},
"db_language_id": "ac1afb0a-a729-4759-a91e-67bf1065e80f",
"db_language_code": "sample string 7",
"db_title_id": "a61db58e-95f3-4668-845e-64c88a0c7186",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-13T02:49:22.021913+00:00",
"create_date": "2026-08-13T02:49:22.021913+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": "2026-08-13T02:49:22.021913+00:00"
},
"modified_dateutc": "2026-08-13T02:49:22.021913+00:00",
"id2": 22
}