ChillBill API v0.2

Authentifizierung

Die Authentifizierung erfolgt über HTTP Basic Auth. Als Benutzername wird der API-Key übergeben, das Passwort bleibt leer.

Beispiel

curl -u myapikey: https://my.chillbill.co/api/v0.2/bills

Rechnungen

Eine Liste aller verarbeiteten Rechnungen kann über den Endpunkt https://my.chillbill.co/api/v0.2/bills abgerufen werden.

Als Antwort kommt ein JSON-Array zurück, das so aussieht:

[{
  "id": "zkHqy45y3K6bM6DEM"
  "billNumber": 123,
  "invoiceDate": "2015-08-25",
  "dueDate": "2015-09-07",
  "organization": {
    "name": "T-Mobile Austria GmbH",
    "vatNumber": "ATU45011703"
  }
  "invoiceNumber": "87623197654",
  "amounts": [{
    "total": 2890,
    "vatRate": 20
  }, {
    "total": 250,
    "vatRate": 0
  }],
  "currencyCode": "EUR"
  "documentUrl": "https://my.chillbill.co/my-bill-document-path"
}]

Attribute

Attribut Typ Beschreibung Beispiel
id
String

Eindeutiger Identifikationsstring der Rechnung.

"zkHqy45y3K6bM6DEM"
billNumber
Integer

Fortlaufende Nummer einer Rechnung.

Die Nummer ist insbesondere zur Filterung nützlich.

123
invoiceDate
String

Rechnungsdatum im Format YYYY-MM-DD

"2015-01-18"
dueDate
String

Fälligkeitsdatum im Format YYYY-MM-DD . Falls kein Fälligkeitsdatum in der Rechnung ausgewiesen ist, hat das Fälligkeitsdatum den gleichen Wert wie das Rechnnugsdatum.

"2015-01-18"
organization.name
String

Lieferant. Kann im Wortlaut von dem Lieferanten auf der Rechnung abweichen, da ChillBill immer versucht, die korrekte Unternehmensbezeichnung zu ermitteln.

"Lidl Österreich GmbH"
organization.vatNumber
String

UID-Nummer des Unternehmens, sofern vorhanden und bekannt.

"ATU45011703"
invoiceNumber
String

Rechnungsnummer wie auf der Rechnung angegeben. Enthält die Rechnung keine Rechnungsnummer, wird versucht, eine eindeutige Identifikationsnummer in der Rechnung zu finden (z.B. Bestellnummer oder Kundendaten in Erlagschein).

"ABC 123 #456/3"
amounts
Array

Liste von Bruttobeträgen mit dazugehörigem Mehrwertsteuersatz.

[{
  total: 379,
  vatRate: 20
}]
amounts.$.total
Number

Ganzzahliger Bruttobetrag in der kleinsten Einheit der Währung (z.B. in Euro-Cents).

2990
amounts.$.vatRate
Number

Ganzzahliger Mehrwertsteuersatz in Prozent.

20
documentUrl
String

URL unter der das originale Dokument abgerufen werden kann, das an ChillBill übermittelt wurde.

"https://my.chillbill.co/my-bill-document-path"

Filter

Um nur neuere Rechnungen abzurufen, kann der GET-Parameter afterBillNumber übergeben werden. Ruft man die API über die URL

curl -u myapikey: https://my.chillbill.co/api/v0.2/bills?afterBillNumber=123

ab, werden nur die Rechnungen ab billNumber 124 zurückgegeben.