|
Die Funktionen der eMSP API sind standardmäßig in keiner Lizenz enthalten. Sollten Sie Interesse an der Nutzung dieser haben, kontaktieren Sie bitte Ihren direkten Sales-Ansprechpartner/ Ihre direkte Sales-Ansprechpartnerin. |
Die eMSP API von be.ENERGISED wurde um zwei Endpunkte erweitert. Ab sofort stellen wir Ihnen einen GET/credit-notes und einen PUT/credit-notes/close Endpunkt zur Verfügung.
Mit dem GET/credit-notes Endpunkt können Sie Daten zu Gutschriften auf Basis von ausgewählten Filtern und Kriterien abrufen. Bitte beachten Sie, dass nur die von Ihnen erstellten Gutschriften abgerufen werden können. Folgende Felder können in diesem Zusammenhang abgefragt werden:
{
"pagination": {
"total": 0,
"offset": 0,
"limit": 0,
"lastPage": true,
"links": {
"current": "string",
"next": "string",
"prev": "string"
}
},
"data": [
{
"id": "string",
"name": "string",
"number": "string",
"reference": "string",
"amount": {
"netTotal": "string",
"netLocalCurrency": "string",
"grossTotal": "string",
"grossLocalCurrency": "string",
"currency": "string",
"currencyExchangeRate": 0
},
"status": "string",
"dateDocument": {
"date": "string",
"timezone_type": 0,
"timezone": "string"
},
"datePayed": {
"date": "string",
"timezone_type": 0,
"timezone": "string"
},
"dueDate": {
"date": "string",
"timezone_type": 0,
"timezone": "string"
},
"paymentTerms": "string",
"paymentText": "string",
"contact": {
"id": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"street": "string",
"state": "string",
"zip": "string",
"city": "string",
"vat": "string",
"externalReference": "string"
},
"entityId": "string",
"additionalFields": [
{
"slug": "sample_dynamic_test_slug",
"value": "string"
}
],
"type": 0
}
]
}
Der PUT/credit-notes/close Endpunkt ist im Normalfall nur dann für Sie relevant, wenn die Auszahlung der Gutschrift in Ihrer Verantwortung liegt. Mit diesem PUT-Befehl können Gutschriften gesammelt als "abgeschlossen" markiert werden. Die im Feld "paymentText" angegebenen Informationen werden ebenfalls berücksichtigt und auf dem Gutschrift-PDF ausgewiesen.
- Beispielhafter "Request":
[
{
"id": "string",
"paymentText": "string",
"datePayed": "string"
}
]
- Beispielhafte (erfolgreiche) "Response":
{
"data": [
{
"id": "string",
"message": "CREDIT_NOTE_CLOSED",
"status": 201
}
]
}
Weitere Informationen zu eMSP API können Sie über diesen Link einsehen.
Version: 2023-08-30 14:24:28 UTC