Skip to main content
GET
Delivers a single company

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

CompanyId
string<uuid>
required

Represents a key for identifying a firm within the application.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Response

Single row of the company table

id
string<uuid>

Unique ID to identify a company (kFirma).

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

companyName
string

Name of the company.

owner
string

Owner of the company.

street
string

Street address of the company.

postalCode
string

Postal code of the company.

city
string

City of the company.

country
string

Country of the company.

countryIsoCode
string

Country ISO code.

phone
string

Phone number of the company.

fax
string

Fax number of the company.

emailAddress
string

Email address of the company.

website
string

Website of the company.

bankCode
string

Bank code.

accountNumber
string

Bank account number.

bankName
string

Name of the bank.

taxId
string

Tax identification number.

iBAN
string

International Bank Account Number.

bIC
string

Bank Identifier Code.

accountHolder
string

Bank account holder name.

creditorId
string

Creditor identification number.

payPalEmailAddress
string

PayPal email address of the company.

isSmallBusinessOwner
boolean

Indicates if the company is a small business owner.

dHLIntrashipCustomerId
string

DHL Intraship customer Id for shipping.

uPSCustomerId
string

UPS customer Id for shipping.

companyVatIdentifiers
object[]

List of company vat ids.