Dibito REST API (1.1)

The Dibito REST API provides services to submit, verify and deliver eBills. The API is designed to be used by biller integrations.

Product Website

https://www.dibito.ch

API Key

This API requires an API key to be passed in the `X-API-Key` header.
Generate your API key in the Dibito application under "Dibito -> API Keys".

Further Informations

Consult our documentation for futher informations about creating and handling eBills.
Download OpenAPI description
api-docs.json
api-docs.yaml
Overview
URL

https://www.codeblock.ch

Codeblock GmbH

contact@codeblock.ch

Languages
Servers
Generated server url

https://app.dibito.ch/

00 Examples

Operations

10 Business Cases

Operations

20 Bill Recipients

Operations

21 Bill-Recipient Subscriptions

Operations

30 Events

Operations

Find events for business cases that changed processing status

Request

Events business cases that changed processing status

Security
X-API-Key
Query
lastEventIdinteger(int32)

Id of the last received event. If omitted, the result starts with the oldest available event. Example: "12345"

limitinteger(int32)<= 1000

Maximum number of items to be returned (technical maximum is 1000, no more will be returned).

Default 100
curl -i -X GET \
  'https://app.dibito.ch/api/v1/events/processing-status-changed?lastEventId=0&limit=100' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Processing status changed events found

Bodyapplication/jsonArray [
idinteger(int32)required

Event ID

Example: 12345
timestampstring(date-time)required

timestamp of the event

Example: "2015-01-01T10:00Z"
businessCaseIdinteger(int32)

Business Case ID

businessCaseSixIdstring[ 0 .. 36 ] charactersBCID[0-9A-Z]{32}required

business case SIX ID

Example: "BCID0FB909852BBC4D06AD8336AAE87D7FC9"
newStatusstring
Enum"OPEN""INVALID""PROCESSING""FAILED""DELIVERED""DONE"
]
Response
application/json
[
  {
    "id": 12345,
    "timestamp": "2015-01-01T10:00Z",
    "businessCaseId": 0,
    "businessCaseSixId": "BCID0FB909852BBC4D06AD8336AAE87D7FC9",
    "newStatus": "OPEN"
  }
]

31 SIX Events

Operations

40 Webhook Management

Operations

90 PDF

Operations

98 Health Check

Operations

99 Authentication

Operations

webhooks

Webhooks

endpoint-controller

Operations