APapaleo
Company

Get a company

Get a company by ID.<br>You must have at least one of these scopes: 'companies.read, companies.manage'.<br>For fine-grained clients, you must have this permission: 'core.companies.read'.

get/rateplan/v0-nsfw/companies/{id}

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/rateplan/v0-nsfw/companies/{id}
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: companies.read, companies.manage, admin

Path parameters

idstring required

The ID of the company.

Query parameters

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: identifiers. All other values will be silently ignored.

Response

Success.

type'CorporateClient' | 'TravelAgency' | 'GovernmentBuyer' nullable

The company type.

idstring required

The ID of this company

codestring required

The code for the company

propertyIdstring required

The ID of the property

namestring required

The name of the company

invoicingEmailstring nullable

The email address for invoicing purposes

phonestring nullable

The company's phone number

taxIdstring nullable

The tax ID of the company

additionalTaxIdstring nullable

The additional tax ID of the company (e.g. SIRET in France, Codice Destinatario in Italy, SST in Malaysia)

additionalTaxId2string nullable

The additional tax ID of the company (e.g. Codice Fiscale in Italy, BRN in Malaysia)

canCheckOutOnArboolean required

Whether or not the company is allowed to check out on AR / invoice

Example response

{
  "identifiers": [
    {
      "scheme": "PEPPOL:0204",
      "value": "991-12345-37"
    }
  ],
  "type": "GovernmentBuyer",
  "id": "MUC-UMBRELLA",
  "code": "UMBRELLA",
  "propertyId": "MUC",
  "name": "Umbrella Corp.",
  "invoicingEmail": "umbrella@corp.com",
  "phone": "+49 89 12345678",
  "taxId": "Tax 123456",
  "additionalTaxId": "123456789",
  "additionalTaxId2": "987654321",
  "invoiceNetworkIdentity": {
    "network": "Peppol",
    "id": "0208:123456789"
  },
  "address": {
    "addressLine1": "Marienplatz 1",
    "postalCode": "80331",
    "city": "München",
    "countryCode": "DE"
  },
  "canCheckOutOnAr": true,
  "ratePlans": [
    {
      "id": "MUC-DBL",
      "code": "DBL",
      "corporateCode": "UMBRELLAINC",
      "name": "Double room flexible"
    }
  ]
}

Changes

No recorded changes to this operation across all 4 revisions of this API.