APapaleo
Company

Create a company

Use this call to create a new company.<br>You must have at least one of these scopes: 'companies.create, companies.manage'.<br>For fine-grained clients, you must have this permission: 'core.companies.create'.

post/rateplan/v1/companies

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/v1/companies
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: companies.create, companies.manage, admin

Headers

Idempotency-Keystring

Unique key for safely retrying requests without accidentally performing the same operation twice. We'll always send back the same response for requests made with the same key, and keys can't be reused with different request parameters. Keys expire after 24 hours.

Request body

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

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 request

{
  "code": "UMBRELLA",
  "propertyId": "MUC",
  "name": "Umbrella Corp.",
  "invoicingEmail": "umbrella@corp.com",
  "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",
      "corporateCode": "UMBRELLAINC"
    }
  ]
}

Response

Success.

idstring required

The company ID

Example response

{
  "id": "MUC-UMBRELLA"
}

Changes

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