Retrieves the company with the specified key
Request Information
URI Parameters :
Name | Description | Type | Additional information |
---|---|---|---|
id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
companyName | Description | Type | Additional information |
---|---|---|---|
id |
Primary Key |
globally unique identifier |
Required |
is_client |
SALES : Indicate if can be used for ordering |
boolean | |
is_supplier |
SERVICES : indicate if this company is a supplier |
boolean | |
archived |
Archive this company to not have it anymore on the search |
boolean | |
name | string |
Required Max length: 64 |
|
notes |
Notes/Remark field |
string | |
create_date |
Creation date+time |
date | |
sales_territory_id |
Territory of the company (Sales+Services).If more than one sales_territory exists, then it must be filled |
globally unique identifier | |
sales_territory_code |
Embedded entity "sales_territory" using ERP PK when adding/updating company |
string | |
sales_territory |
Embedded entity "sales_territory" using node when adding/updating company |
sales_territory | |
marketing_segment_id |
Marketing Segment of the company (Sales (Visit frequency logic) +Services (Planning Jobs To Be Planned) ) |
globally unique identifier | |
marketing_segment_code |
Embedded entity "marketing_segment" using ERP PK when adding/updating company |
string | |
marketing_segment |
Embedded entity "marketing_segment" using node when adding/updating company |
marketing_segment | |
sales_organization_id |
Organization on which belongs the company.If more than one sales_organization exists, then it must be filled |
globally unique identifier | |
sales_organization_code |
Embedded entity "sales_organization" using ERP PK when adding/updating company |
string | |
sales_organization |
Embedded entity "sales_organization" using node when adding/updating company |
sales_organization | |
company_sales_status_code |
Foreign key of company_sales_status using code. Use "Normal,CreditRisk, BlockedbyCM or OrderBlocked" |
string | |
vat_reg_code |
VAT number |
string |
Max length: 50 |
is_working_address |
Services : If False, you cannot create project/installation on this company.Default=true |
boolean | |
parent_id |
Reference to a parent company (in case of Child/Parent) when adding/updating company |
globally unique identifier | |
parent_company_code |
Embedded entity "company" for parent (in case of Child/Parent) using ERP PK when adding/updating company |
string | |
parent_company |
Embedded entity "company" for parent (in case of Child/Parent) when adding/updating company |
company | |
phone |
Phone number of the company |
string |
Max length: 50 |
fax |
Fax number of the company |
string |
Max length: 50 |
url |
URL of the company website |
string |
Max length: 255 |
|
string |
Max length: 250 |
|
street |
Address:Street |
string |
Max length: 100 |
street_number |
Address:Street Number. If your ERP doesn't have this field, then only use field "street" and disable the street number on Odyssee/Admin/Impl Settings/Global Settings:Hide Street Number |
string |
Max length: 50 |
city |
Address:City |
string |
Max length: 50 |
zip |
Address:Zip |
string |
Max length: 50 |
db_country_id |
Address:Country |
globally unique identifier | |
db_country_code |
Address:CountryCode entity using international code when adding/updating company |
string | |
feelist_id |
FeeList activated for the company (On Service, Feelist determines the price of the invoicable timesheets) |
globally unique identifier | |
feelist_reference_back_office |
Embedded entity "feelist" using ERP PK when adding/updating company |
string | |
feelist |
Embedded entity "feelist" using node when adding/updating company |
feelist | |
company_type_id |
Company Type |
globally unique identifier | |
company_type_name |
Embedded entity "company_type" using ERP PK when adding/updating company |
string | |
company_type |
Embedded entity "company_type" using node when adding/updating company |
company_type | |
db_language_id |
Language of the company.If empty, will use the default on the system |
globally unique identifier | |
db_language_code |
Language code entity using international isocode when adding/updating company |
string | |
code |
Field used for Embedded entity (store there your ERP PK) |
string |
Max length: 50 |
article_price_label_id |
Foreign key of article price label |
globally unique identifier | |
article_price_label_code |
Embedded entity "article price label" using ERP PK when adding/updating |
string | |
article_price_label |
Embedded entity "article price label" when adding/updating |
article_price_label | |
db_payment_method_id |
Embedded entity "db payment methods" using ERP PK when adding/updating company |
globally unique identifier | |
db_payment_method_reference_back_office |
Embedded entity "db payment methods" using ERP PK when adding/updating company |
string | |
db_payment_methods |
Embedded entity "db payment methods" using ERP PK when adding/updating company |
db_payment_methods | |
company_sector_id |
Foreign key to company_sector |
globally unique identifier | |
company_sector_code |
Embedded code for the company_sector using ERP PK when adding/updating |
string | |
company_sector |
Embedded entity for the company_sector using the key from an external system when adding/updating object |
company_sector | |
is_lead |
Indicate that company is not already a customer |
boolean | |
is_subcontractor |
For Service, that company is one of your subcontractors |
boolean | |
latitude |
Decimal coordonate for the latitude. (-1;-1) means invalid and (0;0) means not already geo-encoded |
decimal number | |
longitude |
Decimal coordonate for the longitude. (-1;-1) means invalid and (0;0) means not already geo-encoded |
decimal number | |
street2 |
Additional information on the address not part of the postal address |
string | |
bic_code |
bic code |
string | |
specialities |
specialities |
string | |
register_number |
register_number |
string | |
register_city |
register_city |
string | |
bankaccount |
Bank account of the company. |
string | |
mobile |
Mobile number of the company |
string |
Max length: 50 |
service_manager_user_id |
ID of the service manager. Auto selected user when creating location, installation. Used also inside communication and tags |
globally unique identifier | |
service_manager_user_code |
Embedded code of the service manager. Auto selected user when creating location, installation. Used also inside communication and tags |
string | |
service_manager_user |
Embedded entity of the service manager. Auto selected user when creating location, installation. Used also inside communication and tags |
user | |
finance_manager_user_id |
ID of the finance manager. Only used inside communication and tags |
globally unique identifier | |
finance_manager_user_code |
Embedded code of the finance manager. Only used inside communication and tags |
string | |
finance_manager_user |
Embedded entity of the finance manager. Only used inside communication and tags |
user | |
account_manager_user_id |
ID of the account manager. Only used inside communication and tags |
globally unique identifier | |
account_manager_user_code |
Embedded code of the account manager. Only used inside communication and tags |
string | |
account_manager_user |
Embedded entity of the account manager. Only used inside communication and tags |
user | |
company_status_id |
Company Status |
globally unique identifier | |
invoice_email_to |
Email to send invoice |
string | |
modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
id2 |
Internal ID (numeric) |
integer |
Response Formats
application/json, text/json
{ "id": "c68a77ff-1480-479d-8e47-fc5d19ae5774", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-02-05T06:34:06.7202147+00:00", "sales_territory_id": "3a644ceb-079d-43bc-bdf8-55c04df946c9", "sales_territory_code": "sample string 9", "sales_territory": { "id": "4a1ca67e-4a06-4420-9617-8b16936edb5f", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "f3ba0450-1cca-4f01-8da0-56e11c18956a", "sales_organization_code": "sample string 5", "sales_organization": { "id": "389193e6-704b-400c-b15d-c834d79a9780", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "8e808e66-132e-4e46-9008-65cbd7bd4ed6", "db_currency_id": "74b3479d-6685-4411-af7a-9d97e8241760", "db_language_id": "3f2f52b1-deed-4f8e-8d50-bfcf8bacb7b7", "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-02-05T06:34:06.7202147+00:00" }, "modified_dateutc": "2025-02-05T06:34:06.7202147+00:00" }, "marketing_segment_id": "fe0f0688-ebdb-465e-9dd9-98356b97e09e", "marketing_segment_code": "sample string 11", "sales_organization_id": "b84a368e-4bf0-42ab-95d4-497a498ee28b", "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": "31789773-ee1d-4790-8194-1f2c90193add", "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": "51d9c89b-bc6d-4ac6-8404-262b425e1558", "db_country_code": "sample string 28", "feelist_id": "ca7fcf74-3c88-4566-84ce-1d1d02589354", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "69a9683a-ff78-40e8-ab44-c5b7f4ea7c79", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "fb1fd0f2-c000-4bc1-9978-bc1cea51493a", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-02-05T06:34:06.7202147+00:00", "db_currency_id": "0f4e6631-1aa7-47cf-9101-a8b0e7fc62b8", "db_currency_code": "sample string 10" }, "company_type_id": "85f13e55-ff07-42b9-b741-3d9f0ee36e3e", "company_type_name": "sample string 32", "company_type": { "id": "0d115c82-cf35-4d46-8b8d-f7df56fe47ed", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "3526dfe3-a35b-41c5-9e06-94cbdf815262", "sales_organization_code": "sample string 5" }, "db_language_id": "8e9bd4ec-c688-4297-b901-6c8897da4a9a", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "40f2299b-d9da-49f3-9e51-486f9d3ba714", "article_price_label_code": "sample string 37", "db_payment_method_id": "18327cdb-329a-4a87-9643-e44b3fb65d12", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "49c296a5-161a-474c-8e00-0c33d7dcd790", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-02-05T06:34:06.7202147+00:00" }, "company_sector_id": "4106634c-7a61-47e8-a61d-955356102934", "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": "1bd3e2cc-bbd3-4849-8720-4605e2031bb2", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "613a222d-76c9-4962-8e6e-772057af43fd", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "3461247f-7bb7-4c61-a253-8950a93f2baa", "account_manager_user_code": "sample string 56", "company_status_id": "7c7e09d4-e551-4e26-a6f7-b769f0bcb810", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-02-05T06:34:06.7202147+00:00", "id2": 60 }