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
company| Name | 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": "e9c5819e-320b-4088-89f3-024df9233300",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-02-18T22:47:20.3325337+00:00",
"sales_territory_id": "a677f5ce-375b-43af-ab94-f6d5a2ec860c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ec7451ae-f481-40d9-8bdd-c394005d9c38",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d6eaeb42-640d-4060-bea9-bb8ff0f8c9ac",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "11b299d9-1940-4460-a22f-edce862bca29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6a06361-08cf-4630-b0d9-0741b4eee8fb",
"db_currency_id": "1f882363-de0e-4f61-b756-e77f0a710eab",
"db_language_id": "efa9c7b0-e7a9-4f99-9f15-594bf4928d6c",
"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-18T22:47:20.3325337+00:00"
},
"modified_dateutc": "2025-02-18T22:47:20.3325337+00:00"
},
"marketing_segment_id": "98d5da25-e39e-4d8e-9a3f-1a3d37eae01f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "083407a8-0492-42e8-ae7f-ffe14f9c7c29",
"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": "738bd2aa-38a5-4c73-b402-94147c401710",
"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": "5999f1a8-ab2d-42ea-81a1-a2a0d05b3188",
"db_country_code": "sample string 28",
"feelist_id": "61796595-6bdd-4b41-868e-a56ba065461e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "60b86d0c-4dec-4fdd-a380-c3f57e59f38c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f516e6ab-b5f6-468b-8ce2-7c2d374d8a9a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-02-18T22:47:20.3481707+00:00",
"db_currency_id": "d0a27d19-e068-4b55-bf01-af19e1c3c106",
"db_currency_code": "sample string 10"
},
"company_type_id": "4e25fe72-2ba7-4906-8a2e-e0cf3309aae9",
"company_type_name": "sample string 32",
"company_type": {
"id": "2f9ac9a3-aa7d-4aba-b5d8-e8e9cc0e24e8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ffeb8e67-1915-46ed-b299-e7ac9037954d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5b5d7202-e937-426d-b4e0-d37e0f6a9506",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e415d808-e876-4c84-b53c-b3414d4efa8a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e91466ba-2f0e-43de-8112-b97de8b2951a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ca68f81e-56fd-4f6b-a8d8-6dd1003bf8c4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-02-18T22:47:20.3481707+00:00"
},
"company_sector_id": "f3e40ce8-bacf-41ee-a9c3-694dd5a5769d",
"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": "d5937e10-18d7-4ce7-950a-9c746a7d29e0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "85c38e04-473d-489d-8b8b-20b2d0615da2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "59fe9a46-79ae-4147-85f6-e39c434c10bd",
"account_manager_user_code": "sample string 56",
"company_status_id": "867cf5bc-c302-4ca1-a9c9-73f2e1b6efd6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-02-18T22:47:20.3481707+00:00",
"id2": 60
}