|
The functions of the eMSP API are not included in any subscription by default. If you are interested in using them, please contact your direct sales contact. |
The eMSP API of be.ENERGISED has been extended by two endpoints. From now on, we provide you with a GET/credit-notes and a PUT/credit-notes/close endpoint.
The GET/credit-notes endpoint allows you to retrieve data on credit notes based on selected filters and criteria. Please note that only the credit notes you have created can be retrieved. The following fields can be retrieved in this regard:
{
"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
}
]
}
The PUT/credit-notes/close endpoint is normally only relevant for you if the payment of the credit note is your responsibility. With this PUT command, credit notes can be collectively marked as "closed". The information specified in the "paymentText" field is also taken into account and shown on the credit note PDF.
- Exemplary "Request":
[
{
"id": "string",
"paymentText": "string",
"datePayed": "string"
}
]
- Exemplary (successful) "Response":
{
"data": [
{
"id": "string",
"message": "CREDIT_NOTE_CLOSED",
"status": 201
}
]
}
You can view more information about the eMSP API by clicking this link.
Version: 2023-08-30 14:24:28 UTC