Retrieves the company with the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

company
NameDescriptionTypeAdditional 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

email

email

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

Sample:
{
  "id": "5540f198-5f37-4907-b909-168ddb24375f",
  "is_client": true,
  "is_supplier": true,
  "archived": true,
  "name": "sample string 5",
  "notes": "sample string 6",
  "create_date": "2022-12-02T21:00:18.7732064+01:00",
  "sales_territory_id": "1e31d76e-0845-4695-8351-262b2bca2bd4",
  "sales_territory_code": "sample string 9",
  "sales_territory": {
    "id": "d356c535-f48f-427d-a0c5-9c19bd955b11",
    "code": "sample string 2",
    "description": "sample string 3",
    "sales_organization_id": "ca3f80ca-8e6c-4157-9867-4ee6152c4e1d",
    "sales_organization_code": "sample string 5",
    "sales_organization": {
      "id": "5730a8b5-f129-4142-bba3-48d5c762fb13",
      "code": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "db_country_id": "3eadd891-fea4-4a6b-940e-bd380a6716e3",
      "db_currency_id": "1e33222e-b605-46ce-92a1-394b2ca02db7",
      "db_language_id": "d09cb6c7-ab0f-44e4-9835-6e5234bd6892",
      "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": "2022-12-02T21:00:18.7732064+01:00"
    },
    "modified_dateutc": "2022-12-02T21:00:18.7732064+01:00"
  },
  "marketing_segment_id": "c5c1699d-3451-4511-a2ae-b87647c75627",
  "marketing_segment_code": "sample string 11",
  "sales_organization_id": "b37942d5-ff72-4cfa-b57a-f1871a26c568",
  "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": "b0e84c33-2f89-4169-8a53-9cbb2d12b785",
  "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": "47c2d5f9-fca1-4996-bdaa-b1fa617061b5",
  "db_country_code": "sample string 28",
  "feelist_id": "af167fe4-722b-4a30-8c53-ff809fd053fb",
  "feelist_reference_back_office": "sample string 30",
  "feelist": {
    "id": "c333e5fc-27ce-4223-84fd-80ee0c5d6bef",
    "name": "sample string 2",
    "description": "sample string 3",
    "is_default": true,
    "default_price": 1.0,
    "sales_organization_id": "22ccf948-f4c7-4f84-a91b-58abad7bb7e7",
    "sales_organization_code": "sample string 6",
    "reference_back_office": "sample string 7",
    "modified_dateutc": "2022-12-02T21:00:18.7732064+01:00"
  },
  "company_type_id": "fc78effe-cdb8-4303-9cb8-98a83feff33b",
  "company_type_name": "sample string 32",
  "company_type": {
    "id": "cbec4267-3bdd-4532-8ac1-71548e9524cb",
    "name": "sample string 2",
    "description": "sample string 3",
    "sales_organization_id": "572297c0-3594-4cd9-9abd-9014b99b68a2",
    "sales_organization_code": "sample string 5"
  },
  "db_language_id": "a6c0d1b8-b765-43f7-896f-4c8f3e8de254",
  "db_language_code": "sample string 34",
  "code": "sample string 35",
  "article_price_label_id": "d7797ff1-3772-45b0-8937-9850cef3b336",
  "article_price_label_code": "sample string 37",
  "db_payment_method_id": "9e6c0f40-94a1-44b6-88f5-91a0536724e3",
  "db_payment_method_reference_back_office": "sample string 39",
  "db_payment_methods": {
    "id": "cb36a1c7-07af-42c2-95cc-058d423629c4",
    "name": "sample string 2",
    "description": "sample string 3",
    "reference_back_office": "sample string 4",
    "activated": true,
    "modified_dateutc": "2022-12-02T21:00:18.7732064+01:00"
  },
  "company_sector_id": "09f457ab-09d1-4de1-b33c-8d2ad3806514",
  "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": "e608a49f-3630-45bd-b0bb-f746b304cf3d",
  "service_manager_user_code": "sample string 52",
  "finance_manager_user_id": "bcb407c9-064a-46e4-a257-fab856efb955",
  "finance_manager_user_code": "sample string 54",
  "account_manager_user_id": "f331d7c1-c3d7-4220-b727-9ace902072af",
  "account_manager_user_code": "sample string 56",
  "company_status_id": "c1a2516f-c83a-4cb0-8d30-b017d8289824",
  "invoice_email_to": "sample string 58",
  "modified_dateutc": "2022-12-02T21:00:18.7732064+01:00",
  "id2": 60
}