eBill Network Partner

Update an existing biller.

put/ebill/billers

Request

  • Base URL: https://api.klara.ch
  • URL: https://api.klara.ch/ebill/billers
  • Auth: one of:
    • API key in header X-API-KEY
    • HTTP bearer

Request body

billerIdstring

A unique id for the biller.

status'ACTIVE' | 'INACTIVE' required

The status of the biller.

defaultLanguagestring required

The language will be sent to eBill infrastructure<br />Acceptable values: [ger, fre, ita, eng]

companyNamestring required

The legal name of the company which is displayed in the invoice overview.

sectorIdsstring[] required

The list of assigned sector ids to the biller.

companyUidstring

Swiss enterprise identification number (UID) without dashes, dots or extension.<br />Note that this has to contain the swiss enterprise identification number (UID) from the commercial register (Handelsregister) which may be different from the VAT UID (Mehrwertsteuer UID).

billRecipientSubscriptionStatus'ALLOWED' | 'NOT_ALLOWED' required

If allowed, the biller can be found and bill recipients can subscribe with this biller.

billerDirectSubscriptionSupport'ENABLED' | 'DISABLED' required

Defines whether the biller supports direct subscription.

Example request

{
  "billerId": "BIID0000123456",
  "defaultLanguage": "ger",
  "companyName": "Verlag Neuer",
  "sectorIds": [
    "SCID0000000000"
  ],
  "companyUid": "CHE123456789",
  "accounts": [
    {
      "currencyCode": "CHF",
      "iid": "00100",
      "iban": "CH5489144989413742586"
    }
  ],
  "localized": [
    {
      "companyName": "Neuers Neuste Nachrichten",
      "street": "Neustadtstrasse",
      "zipCode": "6025",
      "city": "Neudorf",
      "language": "GERMAN",
      "email": "abc@gmail.com",
      "mobileNumber": " +41909112233",
      "streetNumber": "39",
      "website": "http://www.abc.com",
      "logo": {
        "name": "company-logo-de",
        "assetId": "ASID0000012345"
      }
    }
  ]
}

Response

Biller updated successfully

billerIdstring

A unique id for the biller.

status'ACTIVE' | 'INACTIVE' required

The status of the biller.

defaultLanguagestring required

The language will be sent to eBill infrastructure<br />Acceptable values: [ger, fre, ita, eng]

companyNamestring required

The legal name of the company which is displayed in the invoice overview.

sectorIdsstring[] required

The list of assigned sector ids to the biller.

companyUidstring

Swiss enterprise identification number (UID) without dashes, dots or extension.<br />Note that this has to contain the swiss enterprise identification number (UID) from the commercial register (Handelsregister) which may be different from the VAT UID (Mehrwertsteuer UID).

billRecipientSubscriptionStatus'ALLOWED' | 'NOT_ALLOWED' required

If allowed, the biller can be found and bill recipients can subscribe with this biller.

billerDirectSubscriptionSupport'ENABLED' | 'DISABLED' required

Defines whether the biller supports direct subscription.

Example response

{
  "billerId": "BIID0000123456",
  "defaultLanguage": "ger",
  "companyName": "Verlag Neuer",
  "sectorIds": [
    "SCID0000000000"
  ],
  "companyUid": "CHE123456789",
  "accounts": [
    {
      "currencyCode": "CHF",
      "iid": "00100",
      "iban": "CH5489144989413742586"
    }
  ],
  "localized": [
    {
      "companyName": "Neuers Neuste Nachrichten",
      "street": "Neustadtstrasse",
      "zipCode": "6025",
      "city": "Neudorf",
      "language": "GERMAN",
      "email": "abc@gmail.com",
      "mobileNumber": " +41909112233",
      "streetNumber": "39",
      "website": "http://www.abc.com",
      "logo": {
        "name": "company-logo-de",
        "assetId": "ASID0000012345"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.