...
Die Benachrichtigungen enthalten jeweils die zur Aktion relevanten Daten im JSON-Format.
Die enthaltenen Datenstrukturen können Sie unserer API-Dokumentation, Abschnitt Schemas im unteren Bereich, entnehmen.
Event Types
Schema documentation: https://api.fakturia.de/documentation/
Section Schemas
| Event Type | Beschreibung DE | Description EN | Schema (payload) |
|---|---|---|---|
| Kunde / Customer | |||
| CUSTOMER_CREATED | Kunde angelegt | Customer created | Attribute: customer Type: Customer |
| CUSTOMER_CHANGED | Kunde geändert | Customer changed | Attribute: customer Type: Customer |
| CUSTOMER_DELETED | Kunde gelöscht | Customer deleted | Attribute: customer Type: Customer |
| CUSTOMER_CHANGEREQUEST_CREATED | Änderung der Kundendaten im Kundencenter beantragt | Change of customer data requested in customer center | Attribute: changeCustomer |
| Artikel / Item | |||
| ITEM_CREATED | Artikel angelegt | Item created | Attribute: item Type: Item |
| ITEM_CHANGED | Artikel geändert | Item changed | Attribute: item Type: Item |
| ITEM_DELETED | Artikel gelöscht | Item deleted | Attribute: item Type: Item |
| Vertrag / Contract | |||
| CONTRACT_CREATED | Vertrag angelegt | Contract created | Attribute: contract Type: Contract |
| CONTRACT_ACTIVATED | Vertrag aktiviert | Contract activated | Attribute: contract Type: Contract |
| CONTRACT_CHANGED | Vertrag geändert | Contract changed | Attribute: contract Type: Contract |
| CONTRACT_TERMINATED | Vertrag gekündigt | Contract terminated | Attribute: contract Type: Contract |
| CONTRACT_ENDED | Vertrag beendet (Vertragsende erreicht) | Contract ended (date of termination reached) | Attribute: contract Type: Contract |
| Rechnung / Invoice | |||
| INVOICE_CREATED | Rechnung erstellt | Invoice created | Attribute: invoice Type: Invoice |
| INVOICE_PAYMENT_RECEIVED | Rechnung: Zahlungseingang erhalten | Invoice: payment received | Attribute: invoice Attribute: payDate Attribute: payAmount |
| INVOICECORRECTION_CREATED | Rechnungskorrektur erstellt | Invoice correction created | Attribute: invoicecorrection Type: InvoiceCorrection |
| Mahnwesen / Dunning | |||
| DUNNING_CREATED | Mahnung verschickt | Dunning sent | Attribute: invoice Attribute: dunningLevel |
| Bestellung / Order | |||
| ORDER_RECEIVED | Bestellung erhalten | Order received | Attribute: orderCustomer Type: OrderCustomer |
| ORDER_PROCESSED | Bestellung: Kunde angelegt | Order: Customer created | Attribute: orderCustomer Attribute: customer |
| ORDER_CANCELLED | Bestellung storniert | Order cancelled | Attribute: orderCustomer Type: OrderCustomer |
| Test | |||
| TESTHOOK | Test-Aufruf | Test call | Attribute: dummyData Type: Dummy |
Example JSON
Each Webhook consists of the following fields:
- eventType: event type (see above)
- triggerDate: date at which the event occured
- retryCount: number of already occured retries
- payLoad: the data attributes (see above)
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"eventType":"CUSTOMER_CREATED",
"triggerDate":"2019-05-22T10:52:15",
"retryCount":0,
"payload":{
"customer":{
"salutation":"MR",
"firstName":"Holger",
"lastName":"Tester",
"companyName":null,
"locale":"de_DE",
"websiteUri":null,
"phone1":null,
"phone2":null,
"telefax":null,
"mobile":null,
"email":"mail@example.net",
"birthdate":null,
"euTaxId":null,
"taxNumber":null,
"noteText":null,
"postalAddress":null,
"billingAddress":{
"addressLine1":"Teststraße 1",
"addressLine2":null,
"addressLine3":null,
"zipCode":"12345",
"cityName":"Testhausen",
"state":null,
"country":"DE"
},
"customerNumber":"K1234",
"taxRegion":"NATIONAL",
"duePeriod":0,
"dueUnit":"DAY",
"paymentMethod":"BANKTRANSFER",
"emailInvoice":null
}
}
} |